SaaS Documentation

Use this skill to plan, draft, and review documentation for SaaS and managed-service products. It covers public customer docs and internal operational docs that affect the customer experience.

This skill is derived from paraphrased guidance in Christopher Gales and the Splunk Documentation Team's The Product Is Docs: Writing Technical Documentation in a Product Development Group, especially Chapter 25, "Writing SaaS Documentation," Chapter 10, "Maintaining Existing Content," Chapter 18, "Working with Customer Support," and Chapter 2, "Agile." Do not copy book prose into user outputs. Source: https://link.springer.com/book/10.1007/978-1-4842-7217-6

Quick Start

1. Load guidelines.md to choose the smallest useful reference set.
2. Identify whether the docs are public customer docs, internal service docs, release notes, runbooks, or support enablement.
3. Define what the provider manages and what the customer controls.
4. Use workflows/plan-saas-docs.md for customer-facing documentation plans.
5. Use workflows/create-saas-runbook.md for operational or support procedures.
6. Return customer impact, prerequisites, responsibilities, release timing, owners, and review needs.

Default Output

When working on SaaS documentation, return: