| name | user-documentation |
| description | Create task-oriented user documentation that explains current product behavior with prerequisites, steps, examples, troubleshooting, and expected results. |
User Documentation
Use for setup guides, how-to articles, help-center pages, tutorials, and operator instructions.
Procedure
- Identify the user's goal and minimum prerequisite knowledge.
- Verify the current product behavior before documenting it.
- Put prerequisites and required permissions before the procedure.
- Write steps in execution order with exact labels, commands, paths, or examples where they matter.
- State the expected result at important checkpoints.
- Add troubleshooting for common, evidenced failure modes rather than speculative edge cases.
- Test the instructions from a clean starting point when practical.
Quality gate
A new user should be able to complete the task without access to internal conversations, implementation notes, or tribal knowledge.