Agent skill

Skill Authoring Guide (Chinese)

by davidYichengWei in davidYichengWei/agentic-engineering-framework

Chinese-language guide to writing and improving SKILL.md files: frontmatter rules, concise writing, progressive disclosure, common patterns and a pre-release checklist.

MITAuto-check passedAgent Workflows

SKILL.md written in Chinese; this summary is our English description.

Install Skill Authoring Guide (Chinese)

skills CLI
$ npx skills add davidYichengWei/agentic-engineering-framework --skill bp-skill-authoring -a claude-code

Project install by default; add -g for ~/.claude/skills/.

GitHub CLI
$ gh skill install davidYichengWei/agentic-engineering-framework bp-skill-authoring --agent claude-code

Project scope by default; add --scope user for a personal install. Needs GitHub CLI 2.90.0 or later (public preview).

Manual copy
$ git clone --depth 1 https://github.com/davidYichengWei/agentic-engineering-framework.git skills-src && mkdir -p .claude/skills && cp -r skills-src/skills/bp-skill-authoring .claude/skills/bp-skill-authoring && rm -rf skills-src

Use ~/.claude/skills/ instead of .claude/skills for a personal install. The folder must contain SKILL.md.

Claude Code skills documentation · loads skills from .claude/skills/

Facts

Skill name
bp-skill-authoring
GitHub stars
158
Token cost
~788 tokens
SKILL.md length
132 words
Files
2
Skills in repo
14
Repo updated
First seen
Licence
MIT

At a glance

Chinese-language guide to writing and improving SKILL.md files: frontmatter rules, concise writing, progressive disclosure, common patterns and a pre-release checklist.

  • Creating a new skill and checking its name and description format
  • SKILL.md covers 语言规范, YAML Frontmatter, 核心原则 and 项目 Skills 目录结构, plus 6 more sections
  • Instructions only: no scripts, shell commands, URLs or credentials in SKILL.md
  • Shortening and restructuring an existing SKILL.md

What it does

The guide sets a house convention that skills are written in Chinese, with descriptions and headings in Chinese while code and identifiers stay in English. It covers frontmatter: a lowercase hyphenated name of at most 64 characters, preferably a gerund phrase, avoiding words like helper or utils and the anthropic and claude prefixes, and a third-person description of what the skill does and when to use it, up to 1024 characters.

Core principles are to add only what the model does not already know, keep the body under 500 lines, allow references only one level deep from SKILL.md, and use forward slashes in paths. It then shows a project skills folder layout, progressive disclosure, template, example, checklist and conditional workflow patterns, a table matching degrees of freedom to task fragility, and an anti-pattern table. A reference file on full best practices covers evaluation-driven development, iterating with a model and designing executable scripts.

When your agent uses it

  • Creating a new skill and checking its name and description format
  • Shortening and restructuring an existing SKILL.md
  • Asking what the conventions for writing skills are

Example prompts

  • “Write a new skill for running our database migrations and follow the authoring conventions.”
  • “Review this SKILL.md and tell me what to cut to keep it under the line limit.”

What it can do on your machine

Read from SKILL.md and the folder at commit 1f7ac0f. It shows what the files ask for, not the result of running them.

  • Tool permissions

    Pre-approves nothing: there is no allowed-tools line, so your agent's usual permission prompts apply.

    From allowed-tools in the SKILL.md frontmatter.

  • Runs code

    No scripts in the folder and no shell commands in SKILL.md (its code samples are markdown and yaml).

    From the folder's file list and the shell code blocks in SKILL.md.

  • Network

    No URLs in SKILL.md.

    From URLs in SKILL.md, links to its own repository left out.

  • Credentials

    Names no API keys, tokens, secrets or passwords.

    From names ending in _API_KEY, _TOKEN, _SECRET, _KEY or _PASSWORD in SKILL.md.

Context cost

Skill Authoring Guide (Chinese) loads about 788 tokens when it runs. Until then it costs about 34 tokens; SKILL.md has 132 words of instructions outside code blocks.

Always · name and description, kept in context so the agent knows when to use it
~34
When it runs · the whole SKILL.md, loaded when a task matches
~788

Estimates: characters ÷ 4, the usual rule of thumb; real counts depend on the model's tokenizer. Scripts and assets cost tokens only if the agent reads them.

Safety

Auto-check passed

The automated check found no risky patterns in SKILL.md.

Automated static check — not a guarantee. Review scripts before installing. It scans the text of SKILL.md for risky patterns (piping downloads into a shell, reading credential files, hidden Unicode, destructive commands); files beside SKILL.md are not scanned.

SKILL.md

The full file from davidYichengWei/agentic-engineering-framework at commit 1f7ac0f, republished under its MIT licence (© davidYichengWei). 132 words, ~788 tokens.

Download SKILL.mdSave it as .claude/skills/bp-skill-authoring/SKILL.md (or your agent's skills folder). This skill also uses 1 other file; get the full folder from GitHub.
name
bp-skill-authoring
description
指导编写和改进 Agent Skill 文件(SKILL.md),涵盖 YAML frontmatter、精简写作、渐进式披露、常用模式。当用户要创建新 Skill、改进现有 SKILL.md、或询问 Skill 编写规范时使用。

编写 Agent Skills

语言规范

Skills 使用中文编写,包括:

  • description:中文描述
  • 章节标题和说明:中文
  • 代码示例和标识符:保持英文

YAML Frontmatter

yaml
---
name: processing-pdfs                    # 小写,连字符,最多 64 字符
description: 从 PDF 文件中提取文本...      # 中文,第三人称,做什么 + 何时用,最多 1024 字符
---

name 格式:

  • 推荐动名词:processing-pdfs, analyzing-data, testing-code
  • 名词短语也可:pdf-processing, data-analysis
  • ❌ 避免:helper, utils, tools, anthropic-*, claude-*

description 规则:

  • ✅ 使用中文,第三人称:"从 PDF 文件中提取文本"
  • ❌ 避免:"我可以帮你..."、"你可以用这个来..."
  • 包含:做什么 + 何时使用 + 关键词

核心原则

精简至上

只添加 AI 尚不知道的信息:

markdown
✅ 好(~50 tokens):
## 锁
使用 TDMutex,不要用 std::mutex:
tdstore::common::TDMutex mutex_;

❌ 差(~150 tokens):
## 锁
线程安全在多线程应用中很重要。
TDStore 使用 bthread 协程,所以需要特殊的锁...
约束条件
  • SKILL.md 正文:< 500 行
  • 引用深度:从 SKILL.md 起只能一层
  • 文件路径:只用正斜杠(reference/guide.md)

项目 Skills 目录结构

skills/
├── <skill-name>/                    # 通用技能
│   └── SKILL.md
└── <module>/                        # 模块专项技能
    └── <skill-name>/
        └── SKILL.md

示例:

skills/
├── writing-skills/                  # 通用:编写 Skills 指南
│   ├── SKILL.md
│   └── reference/
└── backend/                         # 模块:后端
    ├── coding-standards/            # 编码规范
    │   └── SKILL.md
    └── storage-modifications/       # 存储改造规范
        └── SKILL.md

命名规则:

  • 模块名:backend, storage, scheduler 等
  • 技能名:coding-standards, storage-modifications, testing 等
  • 使用小写 + 连字符

渐进式披露

单个 Skill 内部结构:

skill-name/
├── SKILL.md              # 概览(触发时加载)
├── reference/
│   ├── topic-a.md        # 按需加载
│   └── topic-b.md
└── scripts/
    └── validate.py       # 执行,不加载到上下文

在 SKILL.md 中链接到详情:

markdown
## 快速开始
[基本用法]

## 进阶
**主题 A**:参见 [reference/topic-a.md](reference/topic-a.md)
**主题 B**:参见 [reference/topic-b.md](reference/topic-b.md)

常用模式

模板模式
markdown
## 输出格式

始终使用以下结构:
# [标题]
## 摘要
## 发现
## 建议
示例模式
markdown
## Commit 消息

**示例 1:**
输入:Added auth
输出:`feat(auth): implement JWT authentication`

**示例 2:**
输入:Fixed date bug
输出:`fix(reports): correct timezone conversion`
带检查清单的工作流
markdown
## 迁移工作流

复制并跟踪进度:
- [ ] 步骤 1:备份数据库
- [ ] 步骤 2:运行迁移
- [ ] 步骤 3:验证数据

**步骤 1:备份**
运行:`./scripts/backup.sh`
...
条件工作流
markdown
## 选择路径

**创建新的?** → 参见下方"创建"
**编辑现有的?** → 参见下方"编辑"

自由度

自由度适用场景示例
高多种有效方案代码审查指南
中有推荐模式报告模板
低脆弱/关键操作数据库迁移

低自由度 = 精确命令,不允许修改。

发布前检查清单

  • name/description 符合格式要求(小写连字符,第三人称,做什么 + 何时用)
  • 正文 < 500 行,引用一层深
  • 示例具体,术语一致
  • 路径使用正斜杠

反模式

❌ 避免✅ 改为
Windows 路径(docs\file.md)Unix 路径(docs/file.md)
多选项("用 A 或 B 或 C")一个默认 + 逃生口
时效性内容("2025年8月前")"当前" + "旧模式"分节
深层嵌套引用(A→B→C)所有引用从 SKILL.md 发起
解释 AI 已知的内容只写项目特定信息

进阶主题

完成初稿后,阅读 reference/full-best-practices.md 了解:

  • 评估驱动开发
  • 与 AI 迭代优化
  • 可执行脚本设计

© davidYichengWei, MIT. Rendered from Markdown: HTML in the file is shown as text, images as links, and headings moved down two levels. Raw file

Files

SKILL.md and 1 other file in skills/bp-skill-authoring of davidYichengWei/agentic-engineering-framework.

  • SKILL.md
  • reference/full-best-practices.md

Open the folder on GitHubat commit 1f7ac0f

Compare with similar skills

Skill Authoring Guide (Chinese) next to the 5 skills that share the most tags, products or categories with it. Stars are the repository's; “used in” counts other GitHub owners with a copy.

Skill Authoring Guide (Chinese) compared with similar skills
SkillStarsUsed inTokensAuto-checkLicenceRepo updated
Skill Authoring Guide (Chinese) this skilldavidYichengWei/agentic-engineering-framework158—~788Automated safety check: PassMIT
Skill CreatorAzure/azqr79689 repos~8.2kAutomated safety check: PassApache-2.0
Claude Code Skill Developer Guidediet103/claude-code-infrastructure-showcase10k11 repos~3.5kAutomated safety check: PassMIT
Darwin Skill Optimizeralchaincyf/darwin-skill6.2k1 repos~4.7kAutomated safety check: PassMIT
Claude Code Command Developmentanthropics/claude-plugins-official38k10 repos~4.8kAutomated safety check: PassApache-2.0
Claude Code Plugin Structureanthropics/claude-plugins-official38k10 repos~3.4kAutomated safety check: PassApache-2.0

Similar skills

  • Skill Creator

    Azure/azqr

    Official

    Create new skills, modify and improve existing skills, and measure skill performance.

    796 GitHub starsUsed in 89 repos~8.2k tokens
    Agent WorkflowsAuto-check passed
  • Claude Code Skill Developer Guide

    diet103/claude-code-infrastructure-showcase

    A guide to creating and managing Claude Code skills with auto-activation: skill-rules.json triggers, hooks, enforcement levels, YAML frontmatter and progressive disclosure.

    10k GitHub starsUsed in 11 repos~3.5k tokens
    Agent WorkflowsAuto-check passed
  • Darwin Skill Optimizer

    alchaincyf/darwin-skill

    Scores SKILL.md files on a nine-dimension rubric, then improves them in a keep-or-revert loop with independent judge agents, test prompts, git history and human checkpoints.

    6.2k GitHub starsUsed in 1 repo~4.7k tokens
    Agent WorkflowsAuto-check passed
  • Claude Code Command Development

    anthropics/claude-plugins-official

    Official

    Explains how to write Claude Code slash commands: Markdown files with YAML frontmatter, arguments, file references, bash context and interactive prompts.

    38k GitHub starsUsed in 10 repos~4.8k tokens
    Agent WorkflowsAuto-check passed
  • Claude Code Plugin Structure

    anthropics/claude-plugins-official

    Official

    Explains the directory layout, plugin.json manifest and component organization of a Claude Code plugin, including auto-discovery and portable paths.

    38k GitHub starsUsed in 10 repos~3.4k tokens
    Agent WorkflowsAuto-check passed
  • Skill Release Gate

    rohitg00/ai-engineering-from-scratch

    Evaluates an Agent Skill bundle before release for structure, trigger quality, artifact improvement, script correctness, safety, installed-tree integrity and host portability.

    66k GitHub stars~1k tokensUpdated today
    Agent WorkflowsAuto-check passed

More from davidYichengWei/agentic-engineering-framework

All 14 skills in this repo
  • Architecture Design Principles

    davidYichengWei/agentic-engineering-framework

    Gives architecture design principles for system design discussions and code review: module boundaries, dependency direction, data ownership and interface rules, plus a checklist.

    158 GitHub stars~545 tokensUpdated 6 mo ago
    Auto-check passed
  • General Coding Best Practices

    davidYichengWei/agentic-engineering-framework

    A checklist of language-neutral rules for writing and reviewing code: naming, function design, control flow, resource safety, comments and logging.

    158 GitHub stars~631 tokensUpdated 6 mo ago
    Auto-check passed
  • Component Design Principles

    davidYichengWei/agentic-engineering-framework

    Chinese-language checklists for component-level design: class and module structure, public interfaces, data models, concurrency and error handling.

    158 GitHub stars~1k tokensUpdated 6 mo ago
    Auto-check passed
  • Self-Refinement from Corrections

    davidYichengWei/agentic-engineering-framework

    Turns mistakes you correct into proposed updates to persistent Rules and Skills so the same error does not recur in later sessions, triggered automatically or with /reflect.

    158 GitHub stars~575 tokensUpdated 6 mo ago
    Auto-check passed
  • Root-Cause Troubleshooting

    davidYichengWei/agentic-engineering-framework

    Diagnoses compile errors, runtime exceptions, failing tests, pipeline failures and production alerts from code and logs, giving a root cause before any fix.

    158 GitHub stars~646 tokensUpdated 6 mo ago
    Auto-check passed
  • Workflow Code Generation

    davidYichengWei/agentic-engineering-framework

    代码文件修改的统一入口。当用户请求任何代码变更(新功能、优化、Bug 修复、重构)时必须首先调用此 skill。仅适用于代码文件(如 .cc/.cpp/.h/.go/.py 等),修改 .md 等非代码文件时不需要调用。它会评估复杂度、检查 spec.md、生成 tasks.md、并逐个任务执行。

    158 GitHub stars~733 tokensUpdated 6 mo ago
    Auto-check passed

Categories

Questions about Skill Authoring Guide (Chinese)

What does Skill Authoring Guide (Chinese) do?

Chinese-language guide to writing and improving SKILL.md files: frontmatter rules, concise writing, progressive disclosure, common patterns and a pre-release checklist. The guide sets a house convention that skills are written in Chinese, with descriptions and headings in Chinese while code and identifiers stay in English. It covers frontmatter: a lowercase hyphenated name of at most 64 characters, preferably a gerund phrase, avoiding words like helper or utils and the anthropic and claude prefixes, and a third-person description of what the skill does and when to use it, up to 1024 characters.

When should I use Skill Authoring Guide (Chinese)?

Skill Authoring Guide (Chinese) fits situations like: creating a new skill and checking its name and description format; shortening and restructuring an existing SKILL.md; asking what the conventions for writing skills are.

How do I install Skill Authoring Guide (Chinese) in Claude Code?

Run `npx skills add davidYichengWei/agentic-engineering-framework --skill bp-skill-authoring -a claude-code`. Or copy the skill folder (skills/bp-skill-authoring in davidYichengWei/agentic-engineering-framework) into .claude/skills/bp-skill-authoring in your project. Claude Code loads it when a task matches its description.

How do I install Skill Authoring Guide (Chinese) in Codex?

Run `npx skills add davidYichengWei/agentic-engineering-framework --skill bp-skill-authoring -a codex`. Or copy the skill folder (skills/bp-skill-authoring in davidYichengWei/agentic-engineering-framework) into .agents/skills/bp-skill-authoring in your project. Codex loads it when a task matches its description.

Can I use Skill Authoring Guide (Chinese) in Cursor, Gemini CLI or GitHub Copilot?

Cursor, Gemini CLI, GitHub Copilot and OpenCode also load SKILL.md folders. With the skills CLI, run `npx skills add davidYichengWei/agentic-engineering-framework --skill bp-skill-authoring -a cursor` (or -a gemini-cli, github-copilot or opencode for the others). To copy it by hand, put the folder in .cursor/skills/bp-skill-authoring, .gemini/skills/bp-skill-authoring, .github/skills/bp-skill-authoring and .opencode/skills/bp-skill-authoring in your project.

What does Skill Authoring Guide (Chinese) need to run?

SKILL.md names no scripts, command-line tools or credentials: Skill Authoring Guide (Chinese) is instructions for the agent only.

Does Skill Authoring Guide (Chinese) access the network?

SKILL.md contains no URLs. Any network use would come from the scripts or tools the agent runs. This is read from the text; nothing was executed.

Is Skill Authoring Guide (Chinese) safe to install?

Our automated static check of SKILL.md found no risky patterns, such as piping downloads into a shell, reading credential files or hidden Unicode. It is not a guarantee. Review the folder before installing.

What licence does Skill Authoring Guide (Chinese) use?

Skill Authoring Guide (Chinese) is published under the MIT licence (the repository's licence). It allows redistribution, so the full SKILL.md is shown on this page.

How many tokens does Skill Authoring Guide (Chinese) use?

About 788 tokens (SKILL.md is roughly 3.2k characters). Agents keep only the skill's name and description in context until a task matches; then they load SKILL.md in full.

What are the alternatives to Skill Authoring Guide (Chinese)?

Skills that share tags, products or a category with Skill Authoring Guide (Chinese): Skill Creator (Azure/azqr, 796 stars), Claude Code Skill Developer Guide (diet103/claude-code-infrastructure-showcase, 10k stars), Darwin Skill Optimizer (alchaincyf/darwin-skill, 6.2k stars) and Claude Code Command Development (anthropics/claude-plugins-official, 38k stars). The comparison table on this page puts their stars, adoption, token cost, safety result and licence side by side.

Who maintains Skill Authoring Guide (Chinese)?

davidYichengWei (a GitHub user) maintains it in davidYichengWei/agentic-engineering-framework, which has 158 GitHub stars. The repository holds 14 skills in this directory. The repository was last updated on March 25, 2026.

Source: davidYichengWei/agentic-engineering-framework on GitHub. Facts on this page come from the repository at the commit we read; the author's words are quoted as theirs.