mcpField
D
document-writer

document-writer

github.com/404kidwiz开发98 次安装
代码仓库

关于 document-writer

面向软件团队的结构化技术文档编写技能，适用于设计与运维类材料。它提供 ADR、RFC、设计文档、运行手册和事故报告的编写流程。

主要功能

  1. 01ADR 与 RFC
  2. 02系统设计文档
  3. 03技术规格说明
  4. 04运行手册与操作指南
  5. 05事故复盘与 Wiki 文章
  6. 06文档类型选择指引

适用场景

  1. 01记录架构决策
  2. 02准备评审提案
  3. 03说明系统设计
  4. 04记录事故调查结果

安装

复制下面的命令，在终端中运行。

$npx skills add https://github.com/404kidwiz/claude-supercode-skills --skill document-writer

安装后在 Claude Code 中输入/document-writer确认已加载。

详细介绍

文档编写器

用途

擅长为软件系统创建结构化技术文档。专注于架构决策记录、RFC、设计文档和知识库文章。

适用场景

  • 编写架构决策记录（ADR）
  • 创建 RFC（征求意见稿）文档
  • 记录系统设计
  • 编写技术规范
  • 创建运行手册和操作手册
  • 构建内部知识库
  • 记录事件（事后复盘）

快速开始

在以下情况调用此技能：

  • 编写架构决策记录（ADR）
  • 创建 RFC 文档
  • 记录系统设计
  • 编写技术规范
  • 创建运行手册和操作手册

以下情况不要调用：

  • 编写 API 文档（使用 api-documenter）
  • 编写面向用户的文档（使用 technical-writer）
  • 创建 Word 文档（使用 docx-skill）
  • 编写营销内容（使用 content-marketer）

决策框架

Document Type Selection:
├── Decision needed → ADR
├── Proposal for review → RFC
├── System explanation → Design doc
├── How to operate → Runbook
├── Incident occurred → Post-mortem
├── Process definition → SOP
└── Knowledge capture → Wiki article

核心工作流

1. 创建 ADR
  1. 明确要做出的决策
  2. 列出背景和约束
  3. 列出考虑过的选项
  4. 分析优缺点
  5. 陈述决策及其依据
  6. 记录后果
  7. 邀请利益相关方审阅
2. RFC 流程
  1. 编写问题陈述
  2. 提出解决方案
  3. 详细说明实施计划
  4. 说明风险及缓解措施
  5. 定义成功指标
  6. 开放征求意见
  7. 根据反馈迭代
  8. 转为已接受/已拒绝
3. 设计文档
  1. 说明目的和范围
  2. 描述当前状态
  3. 展示拟议设计
  4. 添加图表（C4、时序图）
  5. 说明非功能需求
  6. 列出考虑过的替代方案
  7. 定义上线计划

最佳实践

  • 使用模板以保持一致性
  • 为复杂系统添加图表
  • 为读者而写，而非为自己
  • 保持文档更新
  • 链接相关文档
  • 对所有文档进行版本控制

反模式

反模式问题正确做法
没有模板文档不一致使用标准模板
只写不维护从不更新安排定期审阅
缺少背景读者感到困惑补充背景信息
过于冗长没人阅读简明扼要，链接详细内容
难以查找文档无人使用做好组织和索引

评论

支持 Markdown