SuperAPI AI 工具集

documentation-strategy

写作与研究

查看项目

更新于 10-15 17:07

技能介绍

用途

该技能用于为团队或产品设计并运行一套文档体系,核心是决定“什么内容需要文档化、放在哪里、由谁负责、如何保持新鲜”。它不依赖特定技术栈,适用于内部团队文档、产品文档、运行手册、README 和知识库。

主要能力

该技能提供了一套完整的文档策略框架,包括:

  • 四类文档框架(Diátaxis):将文档分为参考(Reference)、操作指南(How-to)、解释(Explanation)和教程(Tutorial)四类,每类有不同的目的和属性。
  • 五层文档分层:按受众和重要性分为客户面向、跨团队/共享、团队内部、个人草稿和自动生成五个层级,每层有不同的维护标准。
  • 十步工作流:从审计现状、分类分层、识别缺口、清理冗余、选择存放位置、明确归属、设定维护节奏、将文档更新纳入工作、提升可发现性到衡量效果。
  • 具体模式:包括每个项目的 README、架构决策记录(ADR)、运行手册、入职路径、决策日志和术语表。
  • 工具选型指导:对比 Wiki、代码中的 Markdown、文档站点和内部站点等工具类别的适用场景。
  • AI 相关注意事项:关于 LLM 和 AI 助手阅读文档的考虑。
  • 失败模式清单:列举常见的文档失败模式及避免方法。

使用方式

该技能需要以下输入:受众(内部、外部、客户、开发、高管)、现有文档及其状态(位置、形式、最后更新时间)、团队规模和增长轨迹、产生文档的工作类型(工程、产品、运营、支持)以及当前使用的工具。

使用流程为十步:

  1. 审计当前状态:了解存在哪些文档、在哪里、谁拥有、有多新、是否被使用。
  2. 分类和分层:为每个文档确定类别(参考/操作指南/解释/教程)和层级(客户/共享/团队/草稿/生成)。
  3. 识别缺口:找出团队需要但尚不存在的文档。
  4. 识别冗余:找出过时、重复、关于已不存在事物或废弃的草稿,删除或归档。
  5. 选择存放位置:代码仓库(Markdown)用于与代码紧密耦合的文档;Wiki/Notion/Confluence 用于跨团队和团队内部;文档站点(Docusaurus、Mintlify、自定义)用于客户面向;工单/决策日志用于临时记录。
  6. 建立归属:每个文档都有负责人,可以是团队、角色(如值班轮换、PM、EM)或个人加备份。
  7. 建立维护节奏:客户面向按发布加季度审查;跨团队按季度;团队内部按季度;个人草稿无需;自动生成在每次变更时。
  8. 将文档更新纳入工作:新功能、新流程、决策、故障复盘、新员工入职都应伴随文档更新。
  9. 提升可发现性:确保搜索有效、有索引页、交叉链接、搜索别名和常用文档置顶。
  10. 衡量效果:可衡量指标包括页面浏览量、搜索查询(及零结果查询)、“是否有帮助”反馈、页面停留时间、推荐模式;内部文档的定性衡量是同一问题是否被反复询问。

适用场景

  • 为新团队或产品建立文档体系
  • 审计现有文档
  • 修复过时或分散的文档
  • 选择文档工具或平台
  • 定义哪些内容需要文档化、哪些不需要
  • 建立维护节奏
  • 界定技术写作工作范围
  • 设计入职文档(可与 team-onboarding-playbook 配合使用)

限制

该技能不适用于以下场景:

  • 撰写单个文档的实际内容(应使用 content-and-copy)
  • 面向客户的知识库文案(应使用 content-strategy)
  • 代码注释和行内文档(由 code-review-web 覆盖)
  • 一次性博客文章或文章(应使用 content-and-copy)

输出格式

文档策略文档包括:审计(存在什么、在哪里、状态如何)、分层和分类(将框架应用于现有文档)、缺口列表(应该存在但不存在的内容)、工具决策(每种文档放在哪里)、归属映射(谁拥有什么)、维护节奏(何时审查什么)、风格指南(简要的一致性标准)和路线图(填补缺口和清理冗余的优先工作)。

参考文件

references/doc-types-guide.md:四种文档类型(参考、操作指南、解释、教程)的详细指南,包含每种类型的示例和模板。