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 ドキュメントを最新の状態に保ちます。