关于 doc-writer
doc-writer 是用于在项目现有文档结构中创建技术文档的 skill。它帮助团队选择合适的分类，并按对应模板编写文档。
主要功能
- 01检查现有 docs/ 结构
- 02提供文档分类选项
- 03按日期或 ADR 序号命名文件
- 04应用规格、计划、ADR 和参考文档模板
适用场景
- 01为项目添加功能规格
- 02记录架构决策
- 03编写技术计划或参考文档
安装
复制下面的命令，在终端中运行。
$
npx skills add https:/安装后在 Claude Code 中输入/doc-writer确认已加载。
包含的文件
除 SKILL.md 外，安装时一起下载的参考资料和脚本。
references/adr-example.mdadr-template.mdplan-example.mdplan-template.mdreference-example.mdreference-template.mdspec-example.mdspec-template.md详细介绍
文档编写器
用于按照项目的正确结构创建技术文档的技能。
创建流程
步骤 1：查找现有文档结构
检查是否存在 docs/ 及其子文件夹。
步骤 2：确定类别
如果 docs/ 中存在子文件夹：将其作为选项提供。
如果不存在子文件夹，则询问用户：
| 类别 | 用途 |
|---|---|
specs/ | 功能/系统规格说明 |
planning/ | 正在进行的实施计划 |
archive/ | 已完成或已被取代的文档 |
architecture/ | ADR、架构决策 |
reference/ | 技术参考文档 |
backlog/ | 待处理的功能、未来想法 |
work-in-progress/ | 正在编写的文档 |
步骤 3：生成文件名
格式：YYYY-MM-DD-<feature-name>.md
- 使用当前日期（不含时间）
<feature-name>使用 kebab-case，描述清晰，不含空格- 例外：ADR 使用
NNNN-<name>.md（顺序编号）
步骤 4：创建文档
- 如果子文件夹不存在，则创建
- 阅读并应用
references/中对应的模板：- 规格说明：
references/spec-template.md - 计划：
references/plan-template.md - ADR：
references/adr-template.md - 参考文档：
references/reference-template.md
- 规格说明：
- 将文件写入正确位置
资源
如需查看各类文档的完整示例，请阅读 references/ 中的文件：
| 类型 | 模板 | 示例 |
|---|---|---|
| 规格说明 | references/spec-template.md | references/spec-example.md |
| 计划 | references/plan-template.md | references/plan-example.md |
| ADR | references/adr-template.md | references/adr-example.md |
| 参考文档 | references/reference-template.md | references/reference-example.md |
评论
支持 Markdown