davidyichengwei/agentic-engineering-framework/bp-skill-authoring
Claude Code and agent skill by davidyichengwei/agentic-engineering-framework
Trust tier 2
- community
Source check pending
Checking that the SKILL.md file is still in the repository.
指导编写和改进 Agent Skill 文件(SKILL.md),涵盖 YAML frontmatter、精简写作、渐进式披露、常用模式。当用户要创建新 Skill、改进现有 SKILL.md、或询问 Skill 编写规范时使用。
Install
npx vskill@latest install davidyichengwei/agentic-engineering-framework/bp-skill-authoringSKILL.md
编写 Agent Skills
语言规范
Skills 使用中文编写,包括:
description:中文描述- 章节标题和说明:中文
- 代码示例和标识符:保持英文
YAML Frontmatter
name 格式:
- 推荐动名词:
processing-pdfs,analyzing-data,testing-code - 名词短语也可:
pdf-processing,data-analysis - ❌ 避免:
helper,utils,tools,anthropic-*,claude-*
description 规则:
- ✅ 使用中文,第三人称:"从 PDF 文件中提取文本"
- ❌ 避免:"我可以帮你..."、"你可以用这个来..."
- 包含:做什么 + 何时使用 + 关键词
核心原则
精简至上
只添加 AI 尚不知道的信息:
约束条件
- SKILL.md 正文:< 500 行
- 引用深度:从 SKILL.md 起只能一层
- 文件路径:只用正斜杠(
reference/guide.md)
项目 Skills 目录结构
示例:
命名规则:
- 模块名:
backend,storage,scheduler等 - 技能名:
coding-standards,storage-modifications,testing等 - 使用小写 + 连字符
渐进式披露
单个 Skill 内部结构:
在 SKILL.md 中链接到详情:
常用模式
模板模式
示例模式
带检查清单的工作流
条件工作流
自由度
| 自由度 | 适用场景 | 示例 | |
|---|---|---|---|
| 高 | 多种有效方案 | 代码审查指南 | |
| 中 | 有推荐模式 | 报告模板 | |
| 低 | 脆弱/关键操作 | 数据库迁移 |
低自由度 = 精确命令,不允许修改。
发布前检查清单
- [ ]
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 迭代优化
- 可执行脚本设计
Security
- Security scanPassed, 100 of 100Pattern checks on the skill's files.
- Model reviewNot runA model review is scheduled for the next rescan.
Quality evaluation
- Task evaluationNot runNo evaluation yet. Run one in Skill Studio.
Source
- SKILL.md in the repositoryCheckingskills/bp-skill-authoring/SKILL.md
Popularity
- 7-day trend score
- 0
Not refreshed yet.
Works with
Any agent vskill installs to: 56 targets in all. These 39 have a page on this site.
- Claude Code
- Cursor
- GitHub Copilot
- Windsurf
- Codex
- Gemini CLI
- Cline
- Amp
- Roo Code
- Goose
- Continue
- Kilo Code
- Junie
- Trae
- OpenHands
- Qwen Code
- AI Agent
- Tabnine Chat
- Sourcegraph Cody
- Amazon Q
- Firebase Genkit
- Sweep
- Devin
- Phind
- Mentat
- Claude Desktop
- Aider
- GPT Pilot
- Plandex
- bolt.new
- v0
- Replit Agent
- Anse
- TypingMind
- BetterChatGPT
- LibreChat
- Warp AI
- Pieces
- Fig AI
Embed badge
[](https://verified-skill.com/skills/davidyichengwei/agentic-engineering-framework/bp-skill-authoring)