

How to Write a SaaS User Guide: Examples and a Review Checklist

How to Reduce Support Tickets With Better SaaS Documentation

User Guide Software for SaaS Teams: Hosted Docs and In-App Guidance Compared
Use this product documentation template to create a customer-facing page with a clear outcome, prerequisites, ordered actions, a success check, and a recovery path. The blank scaffold below works for setup, everyday tasks, and troubleshooting when you adapt its fields to the reader’s starting point. A filled fictional example shows the level of detail to aim for.
Keep the page focused on one result. A customer setting up an integration needs to know which permissions and inputs are required before they start. Someone fixing a failed connection needs the symptom and safe recovery steps first. The fields are shared, but their order and detail should follow the job.
This is a writing scaffold for individual pages. If you need to decide which pages belong in the library or how to sequence the project, start with the SaaS documentation planning guide. Return to the template once you have an actual task and a source that can confirm its behavior.
Copy the fields into your editor and replace every bracketed prompt. Keep Internal review notes in your editorial workspace rather than publishing private sources or customer case details. Delete sections that do not apply, but do not remove a prerequisite just because it makes the procedure look shorter.
Field | Replace with your product’s verified details |
Task title | [Action + object + meaningful result] |
Purpose and audience | [What readers will finish; who this page applies to] |
Before you begin | [Role, permission, workspace, required input, and supported version] |
Starting point | [Exact place in the interface, command environment, or current product state] |
Procedure | 1. [Action and exact label]. [Expected result].
2. [Next action]. [Check before continuing].
3. [Save or complete the task]. [Effect on data or visibility]. |
Confirm it worked | [Observable success signal; how to check persisted state] |
If it does not work | [Symptom] → [Safe check] → [Recovery or escalation condition]. |
Related information | [A prerequisite, separate task, or reference the reader actually needs] |
Internal review notes | [Content owner; behavior source; tested role/version; last checked; release trigger] |
The title should describe something a reader can do. “Schedule a weekly usage report” is more useful than “Reports overview” when the page’s purpose is to create a schedule. If the reader needs to understand all report types before choosing one, link to that reference separately.
Treat the Procedure field as an instruction to create a real ordered list, rather than leaving several actions inside a table cell. Put warnings before the action they affect. For an export, say what data leaves the product before instructing the reader to create or send the file.
For setup content, make Before you begin prominent. Name the roles, inputs, and external services that must be ready, then finish with a connection or validation check. Distinguish saving a configuration from making the integration active if the product has separate controls.
Do not turn a required permission into an unexplained error at step six. If readers need an administrator, say that early and tell them what to request. Include a recovery path if a connection expires or the external account changes. Verify each condition against the supported product version.
For a routine task, emphasize the starting location, the action sequence, and the persisted result. Group closely related actions when readers perform them in the same dialog. Split a step if the second action requires a decision or a new screen.
State the effect of Save, Publish, Share, and Send precisely. A saved draft may be visible only to its author, while a published change may affect every workspace member. The template cannot infer those consequences from a button label. Check them with someone responsible for the feature.
For a troubleshooting page, replace the task introduction with the exact symptom, when it appears, and who it affects. Begin with safe checks and put recovery actions in their execution order. Explain how to confirm that the original problem is resolved.
Set a stopping condition. If the safe checks fail, explain when to contact support and what non-sensitive context to include. Avoid instructions that require readers to guess at a destructive action. Account-specific fixes should remain with the responsible support or engineering team.
The following page describes an invented SaaS product, Compass Reports. Its labels, permissions, and behavior are fictional teaching material. They are not Hyperdocs features or a tested customer workflow. Use the example to judge completeness, then replace its details with evidence from your own product.
Title: Schedule a private weekly usage report.
Purpose: Create a recurring report that you can open each Monday in your own Reports workspace.
Before you begin: You need a Compass Reports account, access to the intended workspace, and permission to create private report schedules. At least one completed usage record must exist for that workspace. This procedure creates a private report; it does not email a file or share data with colleagues.
Starting point: Open the intended workspace and select Reports. Confirm the workspace name before choosing report settings.
Confirm it worked: Leave Reports, return to Scheduled reports, and reopen the saved schedule. Check that the time zone, recurrence, and privacy setting persisted. The next scheduled run should be listed. The example does not treat an on-screen save message as proof that the future run has already completed.
Save schedule is unavailable: Confirm that you can create schedules in this workspace. If your role does not allow it, ask the workspace administrator for the required access. Do not use someone else’s account to finish the task.
The preview is empty: Check whether the selected week contains usage records you can access. Choose a week with records to validate the preview. Keep the intended recurring schedule unchanged unless the reporting requirement has also changed.
The next run time looks wrong: Reopen the schedule and check the selected time zone. Confirm the workspace setting with an administrator before changing it, since other schedules may use that setting.
Related information: In a real product, link here to the supported time-zone reference and the separate procedure for sharing an existing report. Do not add placeholder links to the published page.
Internal review notes: Assign an owner for reporting content. Record the source specification, the account role used to check the steps, and the product release reviewed. In this fictional example those notes are prompts, not a claim that a real verification happened.
Use the filled page as a test of the template. Can a reader identify the workspace, permission, and expected outcome without opening another article? Does every action use a label that exists in the supported interface? Can the reviewer distinguish a saved configuration from a completed background job?
Have a subject expert verify behavior and a reviewer with the intended role follow the procedure from the stated starting point. Check one likely exception as well as the main path. If AI helped produce the draft, review its permissions, defaults, and failure handling against current evidence. A plausible instruction is still an unverified instruction.
If a screenshot clarifies a control, capture it in a demo environment, remove private data, and keep the important action in text. Include the supported version and capture date in the review notes. Do not use an image as the only place that explains a required setting.
The SaaS documentation checklist covers planning, review, publishing, and maintenance across the release. Use it for that broader process; keep this page’s scaffold focused on the content a customer will read.
Store one blank master in the editorial workspace. When a writer copies it, give the new page a specific task title and a named owner. Do not publish the empty master as though it were customer help. Its prompts are there to expose missing evidence before release.
Create one canonical page for each task and supported context. If setup instructions are repeated across three guides, move the common prerequisite into its own maintained page and link to it when useful. Keep a short statement of the requirement in each task so readers understand why the link matters.
Choose publishing software after you understand who will write, verify, and update the pages. Hyperdocs’ product documentation software is one option for maintaining that content. Its block editor supports headings, ordered lists, and images, with a preview before publishing. A content owner still needs to confirm the procedure.
The Diataxis how-to guidance supports keeping a page centered on a practical task. Google’s procedure guidance describes ordered actions and useful results. Microsoft’s instruction-writing guidance emphasizes clear starting context and actionable steps. The template and Compass Reports example are original editorial material.
Include a task outcome, audience, prerequisites, starting point, actions, a success check, recovery guidance, and internal ownership and review notes.
Yes, but adapt its emphasis. Setup starts with requirements; troubleshooting starts with a recognizable symptom and safe checks. Keep each finished page focused on one reader job.
Keep private source links, account details, reviewer records, and internal release notes in the editorial workspace. Publish only the information customers need.
No. Use an image when it clarifies an unfamiliar control or a decision. Keep required actions and settings in text, and verify that any image is current and safe to share.
Verify labels, permissions, defaults, data effects, and recovery steps against current product evidence. Have an accountable reviewer confirm behavior before publishing.
Recheck it when a release changes the relevant interface, permission, input, default, or result, or when support reports a recurring gap. Record an owner and a trigger in the review notes.
Subscribe to Our Newsletter
Stay up to date with our latest news and updates.