documentation-platform-selection

文档平台选择

使用此技能来选择、比较、试用或迁移文档平台和创作工具。它会让决策始终以读者体验、作者工作流、维护实际情况和迁移风险为依据。

此技能改编自 Christopher Gales 和 Splunk Documentation Team 所著《The Product Is Docs: Writing Technical Documentation in a Product Development Group》中的概述性指导，尤其是第 17 章“工具与内容交付”，以及第 3 章和第 10 章中有关维护和受众的相关指导。请勿在面向用户的输出中复制书中的原文。来源：https://link.springer.com/book/10.1007/978-1-4842-7217-6

快速开始

1. 加载 guidelines.md，选择最精简且实用的参考资料集。
2. 说明当前痛点、目标读者体验、作者工作流和约束条件。
3. 使用 workflows/evaluate-doc-platform.md 比较选项。
4. 需要规划迁移或试用时，使用 workflows/plan-doc-migration-pilot.md。
5. 区分工具问题与流程、归属责任和信息架构问题。
6. 提供需求、对比、建议、迁移风险、试用计划和待解决的问题。

默认输出

评估文档平台时，请提供：

1. 决策背景 - 当前痛点、受众、内容类型、团队工作流和约束条件。
2. 需求 - 读者、创作、内容模型、集成、维护、迁移、可移植性、支持和成本方面的需求。
3. 选项对比 - 加权权衡、适配度、风险和实施负担。
4. 流程问题 - 仅靠工具无法解决的归属责任、信息架构、审核、元数据或维护问题。
5. 建议 - 保留现状、改进流程、试用、迁移或拒绝。
6. 试用或迁移计划 - 范围、成功标准、回滚方案、负责人和时间表。

目录

需求	从此处开始
了解平台选择概念	references/core/knowledge.md
评估并比较工具	workflows/evaluate-doc-platform.md
规划迁移或试用	workflows/plan-doc-migration-pilot.md
按任务或症状查找内容	guidelines.md

核心原则

• 从读者和作者的目标出发，而非供应商功能。
• 先诊断流程问题，再归咎于工具。
• 将迁移视为内容、URL、元数据、搜索和工作流的变更。
• 除非有意接受供应商锁定作为权衡，否则优先考虑可移植性。
• 选择团队确实能够维护的平台。