SuperAPI AI 工具集

document-writer

写作与研究

查看项目

更新于 10-15 08:44

技能介绍

用途

Document Writer 是一个用于创建结构化技术文档的技能,面向软件系统的技术文档编写,专精于架构决策记录(ADR)、RFC、设计文档和知识库文章。

主要能力

  • 编写架构决策记录(ADR)
  • 创建 RFC(Request for Comments)文档
  • 记录系统设计
  • 编写技术规范
  • 创建运行手册和操作手册(runbooks 和 playbooks)
  • 构建内部知识库
  • 记录事故(事后复盘 post-mortems)

使用方式

在以下场景调用该技能:编写架构决策记录(ADR)、创建 RFC 文档、记录系统设计、编写技术规范、创建运行手册和操作手册。

不要在以下场景调用:编写 API 文档(使用 api-documenter)、编写面向用户的文档(使用 technical-writer)、创建 Word 文档(使用 docx-skill)、编写营销内容(使用 content-marketer)。

文档类型选择框架

  • 需要做决策 → ADR
  • 需要评审的提案 → RFC
  • 系统说明 → 设计文档
  • 如何操作 → 运行手册
  • 发生事故 → 事后复盘
  • 流程定义 → SOP
  • 知识沉淀 → Wiki 文章

ADR 创建流程

  1. 确定要做的决策
  2. 列出背景与约束
  3. 枚举考虑过的选项
  4. 分析利弊
  5. 陈述决策及理由
  6. 记录后果
  7. 获取相关方评审

RFC 流程

  1. 撰写问题陈述
  2. 提出解决方案思路
  3. 详述实施计划
  4. 说明风险与缓解措施
  5. 定义成功指标
  6. 开放评论
  7. 根据反馈迭代
  8. 转为已接受/已拒绝

设计文档流程

  1. 说明目的与范围
  2. 描述当前状态
  3. 呈现提出的设计
  4. 包含图表(C4、时序图)
  5. 处理非功能性需求
  6. 列出考虑过的替代方案
  7. 定义发布计划

适用场景

适合软件团队在记录架构决策、评审提案、说明系统设计、编写技术规范、沉淀运维操作流程、构建内部知识库以及事故复盘时使用。

最佳实践

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

反模式

  • 无模板:文档不一致,应使用标准模板
  • 只写不更新:从不更新,应安排评审
  • 缺少背景:读者困惑,应包含背景信息
  • 过于冗长:没人阅读,应简洁并链接细节
  • 难以发现:文档无人使用,应组织并建立索引

限制

该技能不用于 API 文档、面向用户的文档、Word 文档和营销内容,这些场景应分别使用 api-documenter、technical-writer、docx-skill 和 content-marketer。