saas-documentation

SaaS 文档

使用此技能规划、撰写和审查 SaaS 与托管服务产品的文档。内容涵盖公开的客户文档，以及影响客户体验的内部运营文档。

此技能源自 Christopher Gales 和 Splunk Documentation Team 所著 The Product Is Docs: Writing Technical Documentation in a Product Development Group 中经转述的指导，尤其是第 25 章“Writing SaaS Documentation”、第 10 章“Maintaining Existing Content”、第 18 章“Working with Customer Support”和第 2 章“Agile”。请勿将书中的原文复制到面向用户的输出中。来源：https://link.springer.com/book/10.1007/978-1-4842-7217-6

快速入门

1. 加载 guidelines.md，选择最精简且实用的参考资料集。
2. 确定文档属于公开客户文档、内部服务文档、发行说明、运行手册还是支持赋能材料。
3. 明确服务提供商负责管理的内容，以及客户可以控制的内容。
4. 使用 workflows/plan-saas-docs.md 制定面向客户的文档计划。
5. 使用 workflows/create-saas-runbook.md 编写运营或支持流程。
6. 返回客户影响、前置条件、职责、发行时间、负责人和审查需求。

默认输出

处理 SaaS 文档时，请返回：

1. 受众和载体 - 客户、管理员、支持、运营、一线人员或内部团队。
2. 职责边界 - 服务提供商管理、客户控制、双方共管或不支持。
3. 客户影响 - 所需操作、风险、时间安排、权限、计费、安全或可用性。
4. 文档集建议 - 公开主题、发行说明、支持文章、运行手册、赋能说明或升级路径。
5. 运营就绪情况 - 负责人、审查、事件处理路径、支持信号和更新触发条件。
6. 待解决问题 - 未明确的行为、上线时间、支持流程或职责归属。

目录

需求	从这里开始
了解 SaaS 文档概念	references/core/knowledge.md
规划面向 SaaS 客户的文档	workflows/plan-saas-docs.md
创建支持或运营运行手册	workflows/create-saas-runbook.md
根据任务或症状选择路径	guidelines.md

核心原则

• 将文档视为托管服务的一部分。
• 明确服务提供商和客户各自的职责。
• 记录影响整个服务群的变更时，应说明客户影响和所需操作，而不仅是描述功能。
• 将内部运行手册和支持赋能材料视为客户体验基础设施。
• 根据发行、运营和支持信号，及时更新 SaaS 文档。