developer-docs-planning

开发者文档规划

使用此技能，在起草文档之前决定要创建哪些开发者文档。它会将用户需求映射到内容类型、范围、提纲、负责人、发布背景、调研工作和决策记录。

此技能源自 Docs for Developers: An Engineer's Field Guide to Technical Writing，尤其是第 2 章“规划文档”。它还扩展了 Christopher Gales 和 Splunk Documentation Team 的 The Product Is Docs: Writing Technical Documentation in a Product Development Group 中的改写指南，尤其是第 2 章“敏捷”、第 6 章“文档决策”、第 13 章“技术写作者的调研”、第 14 章“场景驱动的信息开发”和第 22 章“与产品管理团队协作”。请勿将书中的原文复制到用户输出中。来源：https://link.springer.com/book/10.1007/978-1-4842-7217-6

快速入门

1. 加载 guidelines.md，选择最精简且有用的参考资料集。
2. 确认用户目标、受众、产品界面和发布背景。
3. 根据用户任务选择内容类型，而非按内部组织结构选择。
4. 使用 workflows/create-doc-plan.md 制定完整计划。
5. 如果任务涉及决策、调研、场景规划或敏捷集成，请使用相应的专用工作流。
6. 输出提纲，列明文档类型、目的、负责人、事实来源、依赖项和验证方式。

默认输出

规划文档时，请返回：

1. 受众和目标 - 文档面向哪些人，以及必须实现什么目标。
2. 内容类型决策 - 推荐的文档及其适用原因。
3. 文档提纲 - 页面或章节、各自的目的和顺序。
4. 决策或调研依据 - 已知证据、假设和未解决的问题。
5. 事实来源映射 - 代码、API 架构、产品负责人、支持数据或设计来源。
6. 发布和审核计划 - 负责人、审批和时间安排。
7. 待解决问题 - 阻碍文档准确性的决策。

目录

需求	从此处开始
了解文档类型	references/core/knowledge.md
应用规划规则	references/core/knowledge.md
查看计划示例	references/core/knowledge.md
制定文档计划	workflows/create-doc-plan.md
做出文档决策	workflows/make-doc-decision.md
写作前调研功能	workflows/research-feature-docs.md
规划场景驱动的文档	workflows/plan-scenario-docs.md
将文档集成到敏捷工作中	workflows/integrate-docs-agile.md
按任务选择入口	guidelines.md

核心原则

• 根据用户任务选择内容类型。
• 每份文档都应围绕一个主要目标。
• 将计划视为轻量级工程产物，而非形式主义。
• 尽早揭示决策、假设和事实来源缺口。
• 如果文档计划像迷宫一样复杂，请考虑产品或信息架构是否过于复杂。