saas-documentation
Plan and write SaaS documentation for managed services, continuous releases, provider/customer responsibility boundaries, UI/browser constraints, runbooks, support enablement, and release readiness. Use when documenting cloud products, hosted services, admin consoles, fleet-wide changes, service operations, incident or runbook procedures, SaaS release notes, customer-controlled settings, or internal docs that support customer experience.
- License 许可
- MIT
- 最近更新
- 2026-11-14
- Stars
- ★ 1.6k
- Forks
- 491
01 前言 Front Matter
- name
- saas-documentation
- license
- MIT
- metadata
- { "tags": "developer-docs,technical-writing,documentation,saas,operations", "version": "0.1.0", "category": "Writing", "displayName": "SaaS Documentation" }
- description
- Plan and write SaaS documentation for managed services, continuous releases, provider/customer responsibility boundaries, UI/browser constraints, runbooks, support enablement, and release readiness. Use when documenting cloud products, hosted services, admin consoles, fleet-wide changes, service operations, incident or runbook procedures, SaaS release notes, customer-controlled settings, or internal docs that support customer experience.
- compatibility
- Codex, Claude Code, and other Agent Skills-compatible clients.
02 资源文件 4
- 参考文档guidelines.md2.1 KB
- 参考文档references/core/knowledge.md7.1 KB
- 参考文档workflows/create-saas-runbook.md3.2 KB
- 参考文档workflows/plan-saas-docs.md3.1 KB
03 SKILL.md 正文
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
- Load
guidelines.mdto choose the smallest useful reference set. - Identify whether the docs are public customer docs, internal service docs, release notes, runbooks, or support enablement.
- Define what the provider manages and what the customer controls.
- Use
workflows/plan-saas-docs.mdfor customer-facing documentation plans. - Use
workflows/create-saas-runbook.mdfor operational or support procedures. - Return customer impact, prerequisites, responsibilities, release timing, owners, and review needs.
Default Output
When working on SaaS documentation, return:
- Audience and surface - customer, admin, support, operations, field, or internal team.
- Responsibility boundary - provider-managed, customer-controlled, shared, or unsupported.
- Customer impact - action required, risk, timing, permissions, billing, security, or availability.
- Doc set recommendation - public topic, release note, support article, runbook, enablement note, or escalation path.
- Operational readiness - owners, review, incident path, support signals, and update triggers.
- Open questions - unresolved behavior, launch timing, support process, or ownership.
Contents
| Need | Start Here |
|---|---|
| Understand SaaS documentation concepts | references/core/knowledge.md |
| Plan SaaS customer-facing docs | workflows/plan-saas-docs.md |
| Create support or operations runbooks | workflows/create-saas-runbook.md |
| Route by task or symptom | guidelines.md |
Core Posture
- Treat documentation as part of the managed service.
- Make provider and customer responsibilities explicit.
- Document fleet-wide change with customer impact and action, not just feature description.
- Treat internal runbooks and support enablement as customer-experience infrastructure.
- Keep SaaS docs current with release, operations, and support signals.
04 同仓库更多 Skills
worktable-review-with-annotations
Create, inspect, reply to, update, or resolve situated Worktable annotations. Use when feedback belongs to a Doc section, block, text range, or HTML Doc, or when the user asks to address existing review feedback and coordinate a requested artifact edit.
worktable-find-and-synthesize-context
Find, assess, and synthesize context from Worktable Docs and Records. Use when the user asks what a workspace contains, wants workspace-backed research, needs current facts reconciled across artifacts, or requests a cited synthesis without changing workspace state.
worktable-create-or-update-docs
Create, edit, rename, or maintain narrative Worktable Docs. Use for plans, decisions, briefs, notes, research syntheses, and other durable prose when the user requests a new artifact or a safe update to an existing one.
worktable-create-or-manage-records
Organize repeated structured information as durable Worktable Records. Use for research datasets, inventories, directories, pipelines, trackers, and other collections whose items need identity, fields, filtering, links, validation, or individual updates.
worktable-create-or-manage-interactive-html
Create or improve durable visual and interactive artifacts in Worktable. Use for dashboards, trackers, calculators, mini apps, slide presentations, and other requests that benefit from a polished HTML Doc.
worktable-collaborate-threads
Read, answer, and hand off messages through durable Worktable threads with users or other authenticated participants. Use when the user asks to check addressed messages, reply to a participant, continue a thread, request another agent's help, wait briefly for a response, or watch for comments and messages sent to the agent.