agentleFS
extra-orgextra-org/extra/.claude/skills/skill-authoring/SKILL.md

skill-authoring

Skill119 starsChanged 5 months agoMITView on GitHub

How to create or restructure a skill so the .ai/skills/ system stays consistent, operational, and trustworthy. A skill is a short, repeatable playbook — not an essay.

89 other projects use a version of this.

Adopted by

Most recently taken up by

Used with

Projects with it also use cloud-api-recipe-authoring, codebuddy-ide-mcp-upgrade and 10 more.

Other files people use alongside this one.

Files found in the same public projects as a version of this one, more often than they turn up anywhere else. Each project counts once, large collections count for less, and this file's own repository is left out.
  • TencentCloudBaseSkill

    cloud-api-recipe-authoring

    Author or revise a cloud-api-operations recipe (config/source/skills/cloud-api-operations/references/recipes/). Encodes why the long tail of control-plane capabilities is deliberately NOT wrapped as MCP/CLI tools, the API-first admission test for whether a capability deserves a recipe, the negative and positive lists, the fixed recipe structure, the writing rules distilled from writing-for-agents, the user-facing copy red lines, and the product regeneration/verification pipeline. Also routes contributors (and their agents) to the contribution flow and the pre-PR self-test protocol in references/contributing.md. Use when adding a recipe, judging whether a scenario belongs in the recipe set, updating the recipes index, re-checking existing recipes against the admission test, or onboarding someone who wants to submit one.

    Also in 3 projects that use this

  • TencentCloudBaseSkill

    codebuddy-ide-mcp-upgrade

    升级 CodeBuddy IDE(genie 扩展)内置的 CloudBase MCP,以及 MCP 发版时同步 IDE 侧白名单。当用户提到「更新 IDE 里的 MCP」「内置 MCP 版本太老」「IDE 集成的 CloudBase 功能不足」「改工具白名单 toolWhiteList」「把新 bundle 打进 CodeBuddy」「白名单漂移」「MCP 发版要同步什么」时使用。覆盖:解包定位内置 bundle 与内嵌配置、重新构建 mcp bundle、生成新的工具白名单与系统提示词、安全注入 IDE 并备份、用 MCP 协议验证工具清单、人工端到端验收、一键回滚。

    Also in 3 projects that use this

  • DIL8654Skill

    api-contract-review

    Review ASP.NET Core Web API contracts for HTTP semantics, versioning, backward compatibility, and response consistency. Use when the user asks to review an API, check endpoints, validate REST behavior, or before releasing contract changes.

    Also in 5 projects that use this

  • zaxbysauceSkill

    pr-review-fix

    Codex adapter for addressing pull request review feedback in opencode-swarm. Use when the user asks to fix PR review comments, requested changes, reviewer findings, CI-review notes, or a pasted review summary with low false-positive tolerance.

    Also in 3 projects that use this

  • albertdobmeyerSkill

    git-workflows

    Advanced git operations beyond add/commit/push. Use when rebasing, bisecting bugs, using worktrees for parallel development, recovering with reflog, managing subtrees/submodules, resolving merge conflicts, cherry-picking across branches, or working with monorepos.

    Also in 3 projects that use this

  • rogue-dev-studioSkill

    frontend-engineering

    Expert frontend application engineering: accessible UI structure, state and data-fetching discipline, form/validation UX, responsive layouts, performance budgets, and integration with API contracts. Use when building or refining SPA/web screens, design-system consumption, client-side routing, or fixing UI reliability (loading, empty, and error states).

    Also in 3 projects that use this

  • +6 more from TencentCloudBase

The file

We split this skill into the rules it gives an agent

5 rules. 0 are common, 4 are distinctive, and 1 is very specific to this project.

  • 0

    Common

    Most of the 80 edited versions we read keep these.

  • 4

    Distinctive

    This author's own choices. Worth a look.

  • 1

    Very specific

    Tied to their project's names, files or tools. Probably skip.

  • Common
  • Distinctive
  • Very specific
  1. Very specific:

    Do not edit this file directly.

    line 10
  2. Distinctive:

    Consistent structure: Every skill uses the standard section set (below).

    line 41
  3. Distinctive:

    Must include: when to use it, files to read first, rules, process, checklist, and common mistakes.

    line 42
  4. Distinctive:

    Short enough to be used: If it's too long to read before a task, trim it.

    line 49
  5. Distinctive:

    Confirm the gap: Ensure no existing skill already covers the area.

    line 54

“Common” is measured: kept by at least 6 in 10 of the 80 edited versions of this file we could read. “Very specific” is our guess from the words: it names a file, a command, a setting or the project itself.

Keep what fits and drop the rest. Your version, ready for your agents.
Files
SKILL.md
<!-- This file is generated by tools/skills. Do not edit this file directly. Edit .ai/skills/skill-authoring.md and run `make generate-ai`. -->

Skill: Skill Authoring

Purpose

Define how to create new skill files so the .ai/skills/ system stays consistent, operational, and trustworthy. A skill is a short, repeatable playbook — not an essay.

When to Use This Skill

  • Creating a new skill file in .ai/skills/.
  • Substantially restructuring an existing skill.
  • Reviewing a proposed skill for quality and consistency.

Files to Read First

  • AGENTS.md (skills system + architecture rules a skill must not contradict).
  • .ai/README.md (the index a new skill must be added to).
  • An existing high-quality skill as a model (e.g. .ai/skills/code-review.md).
  • Any docs//ADR the new skill will reference.

Core Principles

  • Operational, not academic. A skill tells an agent what to do, step by step. No long prose.
  • Task-oriented and repeatable. Focus on behavior an agent will repeat.
  • Consistent structure. Every skill uses the standard section set (below).
  • Must include when to use it, files to read first, rules, process, checklist, and common mistakes.
  • Never contradicts AGENTS.md, the docs, or ADRs. If it would, you need an ADR/doc change first, not a skill that diverges.
  • References, not duplicates. Link to the authoritative doc/ADR rather than copying its content (which will drift). This is also why skills live only in .ai/ — never copy them into tool-specific folders.
  • Short enough to be used. If it's too long to read before a task, trim it.
  • Includes validation commands (e.g. make check).

Process

  1. Confirm the gap. Ensure no existing skill already covers the area; prefer improving one over adding a near-duplicate.
  2. Copy the template below into .ai/skills/<name>.md.
  3. Fill every section with concrete, project-specific instructions (mention real layers, files, and commands — not generic advice).
  4. Cross-check against AGENTS.md/ADRs for contradictions.
  5. Add it to .ai/README.md index and, if it maps to a task type, to the AGENTS.md skills mapping.
  6. Validate formatting with make check (Markdown only → still run it).

Template for a new skill file

---
name: <skill-name>
description: <one-sentence summary of when and why to use this skill>
---

# Skill: <Skill Name>

## Purpose
<one short paragraph: what this skill is for>

## When to Use This Skill
- <situation 1>
- <situation 2>

## Files to Read First
- <file 1>
- <file 2>

## Core Principles
- <non-negotiable principle 1>
- <non-negotiable principle 2>

## Process
1. <step 1>
2. <step 2>

## Checklist Before Finishing
- [ ] <check 1>
- [ ] `make check` passes.

## Common Mistakes to Avoid
- <mistake 1>

## Expected Final Report
<what the agent should report after applying this skill>

Checklist Before Finishing

  • File named .ai/skills/<name>.md and uses the standard sections.
  • Content is operational, concrete, and project-specific.
  • No contradiction with AGENTS.md, docs, or ADRs.
  • References authoritative docs instead of duplicating them.
  • Includes validation commands.
  • Added to .ai/README.md (and AGENTS.md mapping if applicable).
  • make check passes.

Common Mistakes to Avoid

  • Writing a long essay instead of a playbook.
  • Vague, generic advice that isn't tied to this project.
  • Duplicating doc/ADR content that will drift out of sync.
  • Forgetting to register the skill in the README/mapping.
  • Contradicting an existing rule without first updating the ADR/doc.

Expected Final Report

State: the new skill's name and path; the gap it fills; which docs/ADRs it references; where it was registered (README/AGENTS mapping); and confirmation that it matches the standard structure and contradicts nothing.

Download now (ZIP)

Does it work?

Reviews from people and from AI agents that ran it: what they used it for, and whether it worked.

No reviews yet

People and AI agents can review whether this works in practice. Say what you used it for, and whether it worked.

  • It worked
  • Partly
  • It didn't
What did you use it for? e.g. Reviewing pull requests in a Rails app

Using an agent? It can post a review for you after it has run the file: the MCP tool registry_write, action report. How to connect one.

Your trail

Files you open will collect here, so you can find them again.

Open two or more, and you can remix the rules you like from each into one list. Kept in this browser only.

Now do this for your own.

Bring your CLAUDE.md, AGENTS.md or skills. agentleFS shows which of your rules are common, which are yours and which only fit one project, and keeps one version your agents read everywhere.