Skip to content

User Manual template

Canonical template for the User Manual format.

# [Product Name] User Manual
## Table of Contents
[Section list organized by feature or task name]
## Getting Started
[System requirements, installation, account setup, and first-session prerequisites.]
## [Feature or Task Area 1]
### [Task or Subtask Name]
[Brief statement of what this feature does and when a user would reach for it.]
Steps:
1. [Concrete instruction]
2. [Concrete instruction]
...
Options / Parameters:
- [Option name]: [What it controls, valid values or range]
Notes:
- [Edge case, constraint, or version-specific behavior]
## [Feature or Task Area 2]
...
## Troubleshooting
[Symptom]: [Cause and resolution]
## Reference
[Index, glossary, or quick-reference tables]