项目文档编写技能 — ADR、README、API 文档、变更日志等标准化模板与工作流
npx skills add https://github.com/kaelen2026/agent-skills --skill documentation이 명령을 Claude Code에 복사하여 붙여넣어 스킬을 설치하세요
| name | documentation |
| description | 项目文档编写技能 — ADR、README、API 文档、变更日志等标准化模板与工作流 |
| metadata | {"filePattern":["**/README.md","**/CONTRIBUTING.md","**/CHANGELOG.md","**/docs/adr/**/*"],"bashPattern":["readme|adr|changelog|文档"],"priority":3} |
以下场景自动激活本技能：
根据需求确定要编写的文档类型：
| 文档类型 | 适用场景 | 参考模板 |
|---|---|---|
| ADR | 技术选型、架构变更、重大权衡 | references/adr-template.md |
| README | 项目介绍、快速上手 | references/project-docs.md |
| CONTRIBUTING | 贡献指南、开发规范 | references/project-docs.md |
| CHANGELOG | 版本发布、变更记录 | references/project-docs.md |
| API 文档 | 接口说明、错误码、认证方式 | references/api-docs.md |
| GitHub 模板 | PR 模板、Issue 模板 | references/project-docs.md |
根据文档类型加载对应的参考模板。模板提供标准结构，按实际需求填充内容。
遵循以下原则：
记录项目中重要的技术决策，包括背景、决策内容、后果和备选方案。详见 references/adr-template.md。
何时编写 ADR：
项目的"门面"。新人应在 5 分钟内理解项目用途并成功运行。详见 references/project-docs.md。
面向 API 消费者的完整参考。包含端点说明、请求/响应示例、错误码、认证方式和速率限制。详见 references/api-docs.md。
遵循 Keep a Changelog 格式，按版本记录所有面向用户的变更。详见 references/project-docs.md。
降低贡献者门槛，明确开发流程、代码规范和 PR 要求。详见 references/project-docs.md。
编写完成后，逐项确认：
# Documentation: {文档类型}
## 文档结构
{生成/更新的文档结构概要}
## 变更内容
{具体的文档变更}
## 设计审查
{审查结果清单，标记通过/未通过}
Agent Skill 编写技能。从需求到完成的标准化工作流：结构设计、frontmatter 配置、references 编写、审查清单。
后端架构模式设计技能。生成分层架构代码（Repository / Service / Controller）、数据库查询优化、缓存策略、弹性模式（限流、后台任务、结构化日志）。
通用代码审查技能，适用于所有语言和框架的代码质量检查
错误处理设计技能。生成错误分类体系、处理模式、日志/监控指南。
前端开发模式技能。React 组件设计、状态管理、性能优化、可访问性最佳实践。
实现前规划技能。提供功能规格书、实施计划、架构设计的标准化模板。