docs-release-maintenance

文档发布维护

使用此技能可确保开发者文档与软件发布和维护周期保持一致。内容涵盖发布准备、所有权、自动化、内容时效性，以及负责任地弃用或删除文档。

此技能源自 Docs for Developers: An Engineer's Field Guide to Technical Writing，尤其是第 7 章“发布文档”和第 11 章“维护和弃用文档”。此外，还参考了 Christopher Gales 和 Splunk Documentation Team 的 The Product Is Docs: Writing Technical Documentation in a Product Development Group 中经过改写的指导，尤其是第 10 章“维护现有内容”、第 25 章“编写 SaaS 文档”和第 2 章“敏捷”。不要将书中的原文复制到用户输出中。来源：https://link.springer.com/book/10.1007/978-1-4842-7217-6

快速入门

1. 加载 guidelines.md，选择最精简且有用的参考资料集。
2. 确定发布内容、受影响的用户、文档负责人、事实来源和发布路径。
3. 使用 workflows/plan-doc-release-maintenance.md 制定发布或维护计划。
4. 如果内容过时、补丁不断累积或依赖项更新需要集中刷新，请使用 workflows/refresh-existing-docs.md。
5. 让文档发布、审核、测试、公告和弃用与代码变更保持一致。
6. 优先采用能减少已知重复劳动的自动化；不要自动化尚不明确的流程。

默认输出

规划发布或维护工作时，返回：

1. 发布或维护范围 - 代码／产品变更及受影响的文档。
2. 用户影响 - 受影响的对象及其需要采取的行动。
3. 发布检查清单 - 负责人、审核人、审批、测试、交付和公告。
4. 维护计划 - 负责人、时效性检查、链接检查、lint 和生成的参考资料。
5. 弃用或删除计划 - 警告、替代方案、迁移指南、重定向和时间安排。
6. 风险和阻碍 - 未经核实的信息、负责人缺失或自动化方面的不足。

目录

需求	从这里开始
了解发布和维护的概念	references/core/knowledge.md
应用生命周期规则	references/core/knowledge.md
查看检查清单示例	references/core/knowledge.md
规划发布、维护或弃用	workflows/plan-doc-release-maintenance.md
刷新现有文档	workflows/refresh-existing-docs.md
根据任务选择路径	guidelines.md

核心原则

• 文档应与其所说明的软件变更一同发布。
• 每份维护中的文档都需要负责人或权威来源。
• 自动化应建立在已理解的手动流程之上。
• 维护工作应先评估范围，再修补内容。
• 弃用和删除是与用户沟通的问题，而不只是清理任务。