npx skills add ab300819/skillsREADME
Skills 模板集合
面向个人开发者的 Claude Code Agent Skills 模板项目,包含 DevDocs 全流程和通用工具 skills。
语言规则
所有 skill 统一遵循:
- 支持中英文提问
- 统一中文回复
- 使用中文生成文档
编号规范
DevDocs 流程使用统一的编号体系实现需求到测试的追溯:
| 类型 | 前缀 | 格式 | 说明 |
|---|---|---|---|
| 功能点 | F | F-XXX | 用户可感知的独立功能 |
| 用户故事 | US | US-XXX | 用户使用场景 |
| 验收标准 | AC | AC-XXX | 可量化的完成条件 |
| 单元测试 | UT | UT-XXX | 验证内部逻辑 |
| 集成测试 | IT | IT-XXX | 验证组件协作 |
| E2E 测试 | E2E | E2E-XXX | 验证用户场景 |
| 洞察建议 | INS | INS-XXX | 审查/调研的改进建议 |
| Bug 记录 | BUG | BUG-XXX | Bug 修复记录 |
| 开发任务 | T | T-XX | 开发任务(2 位编号例外) |
追溯关系:
F-001 (功能点)
└── US-001 (用户故事)
└── AC-001 (验收标准)
├── UT-001 (单元测试)
├── IT-001 (集成测试)
└── E2E-001 (E2E 测试)
INS-001 (洞察建议) → F-XXX (转化为功能点)
文档拆分规范
当文档过大时,按以下规则拆分:
| 文档类型 | 拆分阈值 | 拆分方式 |
|---|---|---|
| 需求文档 | 300 行 或 5+ 功能点 | 主文档 + 用户故事 + NFR |
| 系统设计 | 300 行 或 10+ API | 主文档 + API 设计 + 数据模型 |
| 测试用例 | 300 行 或 30+ 用例 | 概览 + UT + IT + E2E |
| 开发任务 | 300 行 或 20+ 任务 | 概览 + 按层级拆分 |
拆分后文件结构:
docs/devdocs/
├── 01-requirements.md # 需求主文档
├── 01-requirements-stories.md # 用户故事详情(可选)
├── 01-requirements-nfr.md # 非功能性需求(可选)
├── 02-system-design.md # 设计主文档
├── 02-system-design-api.md # API 设计详情(可选)
├── 02-system-design-data.md # 数据模型详情(可选)
├── 03-test-cases.md # 测试用例概览 + 追溯矩阵
├── 03-test-unit.md # 单元测试详情(可选)
├── 03-test-integration.md # 集成测试详情(可选)
├── 03-test-e2e.md # E2E 测试详情(可选)
├── 04-dev-tasks.md # 任务主文档
├── 04-dev-tasks-infra.md # 基础设施任务(可选)
├── 04-dev-tasks-core.md # 核心逻辑任务(可选)
├── 04-dev-tasks-api.md # 接口层任务(可选)
└── 04-dev-tasks-test.md # 测试任务(可选)
小型项目:如内容较少,可保持单一文件,无需拆分。
Skills 概览
| Skill | 命令 | 用途 | 输出文件 |
|---|---|---|---|
| 需求扩写 | /devdocs-requirements | 功能点、用户故事、验收标准 | docs/devdocs/01-requirements.md |
| 系统设计 | /devdocs-system-design | 技术架构和 API 设计(支持增量) | docs/devdocs/02-system-design*.md |
| 测试用例 | /devdocs-test-cases | 单元/集成/E2E 测试用例 | docs/devdocs/03-test-*.md |
| 开发任务 | /devdocs-dev-tasks | 可执行的开发任务拆分 | docs/devdocs/04-dev-tasks*.md |
| 开发工作流 | /devdocs-dev-workflow | 执行单个任务的开发流程 | - |
| 项目改造 | /devdocs-retrofit | 已有项目适配 DevDocs 流程 | docs/devdocs/00-retrofit-report.md |
| 新功能 | /devdocs-feature | 在已有项目中追加新功能 | docs/devdocs/00-feature-log.md |
| 文档同步 | /devdocs-sync | 同步文档与实现进度 | docs/devdocs/00-progress-report.md |
| 项目上下文 | /devdocs-onboard | AI 工具切换时的上下文传递 | docs/devdocs/00-context.md |
| 洞察收集 | /devdocs-insights | 收集改进建议转化为需求 | docs/devdocs/05-insights.md |
| Bug 修复 | /devdocs-bugfix | 测试先行的 Bug 修复流程 | docs/devdocs/05-bugfix-log.md |
| 代码质量 | /code-quality | MTE 原则、重构指导、Review 清单 | - |
| 测试指导 | /testing-guide | 测试质量约束(断言、Mock、变异测试) | - |
| 重构 | /refactor | 系统化重构,测试驱动,安全可追溯 | docs/devdocs/05-refactor-*.md |
| 提交规范 | - | 提交信息格式化与历史风格同步 | - |
| Git 安全 | - | 强制使用 git mv/rm 规范操作 | - |
| UI 规范 | /ui-skills | 构建更好界面的意见约束 | - |
| 工作报告 | /work-report | 生成周报、月报、季报、年终总结 | *.md |
DevDocs 工作流
入口决策树
不确定用哪个工具?按以下优先级判断:
项目是否有 DevDocs 文档?
│
├── 没有 / 不规范 ──────────────────► /devdocs-retrofit(初次改造)
│
└── 有 DevDocs
│
├── 需要了解项目 ──────────────► /devdocs-onboard --read
│
└── 需要开发
│
├── 代码已写好,文档落后 ──► /devdocs-sync --absorb
│
└── 计划新增功能
│
├── 小改动(无架构变更)──► /devdocs-feature --lite
│
└── 大改动(涉及设计)──► /devdocs-feature(分步)
快速参考:
| 你的情况 | 使用命令 |
|---|---|
| 项目没有文档,想规范化 | /devdocs-retrofit |
| 接手项目,想快速了解 | /devdocs-onboard --read |
| 完成开发,准备交接 | /devdocs-onboard --update |
| 写完代码,文档没跟上 | /devdocs-sync --absorb |
| 检查文档和代码是否一致 | /devdocs-sync --check |
| 小功能(配置、UI 微调) | /devdocs-feature --lite |
| 新功能(涉及接口/数据) | /devdocs-feature |
| 修复 Bug | /devdocs-bugfix |
路径选择
根据项目状态选择合适的开发路径:
| 场景 | 推荐路径 | 说明 |
|---|---|---|
| 新功能开发(需求明确) | 路径 A:正向开发 | 从需求开始,逐步细化 |
| 新功能 / 功能迭代 | /devdocs-feature | 延续编号,追加文档 |
| 探索性开发 / 原型验证 | 路径 B:探索后补 | 先写代码,后补文档 |
| 已有项目规范化 | /devdocs-retrofit | 从代码逆向生成文档 |
| Bug 修复 | /devdocs-bugfix | 测试先行,编写失败测试后修复 |
| 小型配置变更 | 直接提交 | 无需流程,遵循 commit 规范 |
路径 A:正向开发(需求驱动)
适用于需求明确的新功能开发:
/devdocs-requirements → /devdocs-system-design → /devdocs-test-cases → /devdoc
...
Publisher
Statistics
Stars0
Forks0
Open Issues0
CreatedJan 12, 2026