SuperAPI AI Directory

kf-skill-naming-creation-organization-rules

General & other

View repository

Updated 10-15 23:56

About this skill

skills creation and organization conventions

This skill is for consistently applying naming conventions and placement policies when adding, renaming, or organizing skills in this repository.

When to use this skill

Use this skill for requests such as the following.

  • I want to create a new skill
  • I want to decide the directory name of a skill
  • I want to review whether the name of an existing skill conforms to the conventions
  • I want to organize skills so they are easy to line up in category order
  • I want to distinguish external skills from self-made skills
  • I want to decide how to assign ASCII skill names and English frontmatter

Assumptions in this repository

1. Distinguish external skills from self-made skills

  • skills-lock.json Skills contained in are treated as originating from external repositories
  • Because external skills assume future updates will be incorporated, in principle do not directly change their directory names or contents
  • Self-made skills are stored under .agents/skills/ and added there

2. Self-made skills start with kf- starting with

  • The directory name of a skill made in this repository starts with kf- starting with
  • kf- is used as the identifier for self-made skills
  • Do not retroactively enforce this convention on existing external skill names

3. Emphasize that similar skills are listed near each other

  • .agents/skills/ When is displayed in alphabetical order, name skills so that skills in the same subject area are listed near each other
  • Therefore,kf- a major category must always be placed immediately after

Naming conventions

Basic form

The directory name and frontmatter name should basically take the following form according to the target repository. Each segment used here is an ASCII English word, and the whole is made kebab-case.

  • melumuccu/ai: kf-large-category-subcategory-subsubcategory-short-summary
  • Other repositories: large-category-subcategory-subsubcategory-short-summary
  • For the English rules of frontmatter, follow the later section "Unify frontmatter in English."

1. melumuccu/ai In , add kf- add

  • This repository (melumuccu/ai) when naming a skill,kf- always add the prefix of
  • kf- A major category must always be placed immediately after
  • Do not retroactively enforce this convention on existing external skill names

2. Do not add a prefix in other repositories

  • melumuccu/ai When naming a skill in a repository other than , do not add a prefix
  • The beginning must always start with a major category
  • Name skills starting from the major category so that similar skills are listed near each other

3. Unify separators to hyphens

  • Do not use underscores
  • The directory name and frontmatter name should use only lowercase alphanumeric characters and hyphens
  • Do not use non-ASCII characters, Japanese, or spaces

4. Major categories are mandatory

  • The major category should be a noun representing the skill's subject domain, not an extension
  • Example: markdown, skill, git, python, shell, research

5. Subcategories are optional

  • After the major category, subcategories may be added only when necessary
  • Do not fix it to the three levels of major/medium/minor
  • First consider whether a major category + about one subcategory is sufficient
  • Do not add unnecessary categories just for classification

6. Place the English overview at the end

  • At the end, place a short English overview that makes the skill's content clear at a glance
  • Keep it to a noun phrase or short feature name whenever possible
  • Do not make it too long

Good example:

  • change-review-checkpoints
  • paper-summary
  • log-analysis
  • comparison-table-formatting

Example to avoid:

  • review-changes-clearly-for-humans
  • read-papers-and-organize-key-points
  • investigate-logs-and-list-possible-causes

7. Unify frontmatter in English

  • name should be the same ASCII kebab-case as the directory name
  • description should be an English sentence of about 1 to 2 sentences explaining the skill's purpose and trigger conditions
  • The body and normal output may be in Japanese, but do not use Japanese in frontmatter

How to decide the major category

1. Reuse existing major categories as much as possible

When creating a new skill, first look at existing skill names and check whether there is a word that can naturally be used as a major category.

Examples that are easy to reuse at present:

  • markdown
  • skill

2. If none exists, you may add a new one

If no existing major category fits the skill you are creating, you may create a new major category.

Examples of candidates to add:

  • git
  • python
  • shell
  • research
  • docs
  • agent
  • prompt

3. Do not use words that are unnatural as subject domains for major categories

  • Do not use verbs or temporary purpose names as major categories
  • A major category should be a noun that functions as an axis for grouping similar skills together

Naming procedure

When deciding a skill name, think in the following order.

  1. Check the target repository.
  2. Decide the subject domain that the skill mainly handles.
  3. Check whether an existing skill has a usable major category, and reuse it if so.
  4. If not enough, add a new major category as a short English noun.
  5. Only if necessary, add one or two subcategories.
  6. Place a short English overview at the end.
  7. melumuccu/ai For kf-large-category-subcategory-...-short-summary, and for other repositories large-category-subcategory-...-short-summary format it as
  8. frontmatter の name match the directory name, anddescription write in English.
  9. Check whether it is too long and whether its meaning is clear when viewed in a list.

Naming examples

Use names like the following as a standard.

melumuccu/ai Examples for :

  • kf-markdown-list-ordered-list-cross-reference
  • kf-markdown-table-comparison-table-formatting
  • kf-markdown-link-internal-link-organization
  • kf-skill-review-skill-description-review
  • kf-skill-tuning-description-optimization
  • kf-git-commit-japanese-commit-message
  • kf-git-review-change-review-checkpoints
  • kf-python-test-pytest-test-addition
  • kf-shell-log-log-analysis
  • kf-research-paper-paper-summary

Examples for other repositories:

  • markdown-list-ordered-list-cross-reference
  • skill-review-skill-description-review
  • git-commit-japanese-commit-message
  • shell-log-log-analysis

Policy for organizing and renaming

1. Exclude external skills from organization

  • skills-lock.json External skills in are not subject to the naming convention
  • If an external skill needs to be changed, prioritize supplementing it with a self-made skill

2. Organize only self-made skills according to the convention

  • When adding, renaming, or relocating a self-made skill, follow this convention
  • melumuccu/ai In , use the prefix, and in other repositories use the form without a prefix kf- use the prefix, and in other repositories use the form without a prefix
  • Prioritize having skills of the same lineage line up, and align the granularity of the major categories

3. After changes, also update the list information

  • After adding, renaming, or deleting a skill, .agents/skills/skills.json regenerate to keep consistency

Policy for output

  • If the user is only asking for name ideas, present multiple candidate names
  • If the user is asking for creation as well, prepare a directory name that follows the convention and SKILL.md prepare
  • First check whether the repository to be named is , and switch the presence or absence of the prefix melumuccu/ai First check whether it is , and switch the presence or absence of the prefix
  • SKILL.md When creating , write the frontmatter in English name と description write in English
  • If necessary, briefly explain why that major category was chosen
  • Avoid excessively fine-grained categorization

Final check

Before returning, please check the following.

  • melumuccu/ai If , the self-made skill name starts with kf- starts with
  • melumuccu/ai If it is other than , do not add a prefix and start from the major category
  • melumuccu/ai If , kf- there is a major category immediately after
  • The delimiter is consistently a hyphen
  • The directory name and the frontmatter name match and are in ASCII kebab-case
  • The major category is a natural noun as a subject area
  • Lower-level categories have not increased unnecessarily
  • The English summary at the end is short and easy to understand
  • frontmatter の description is in English
  • External skills and self-made skills are not being confused
  • It has been confirmed whether the list needs updating after adding or renaming a skill