Writing Command Tutorial Flows
Quick start
Collect or infer:
- •Learning goal (what user will accomplish)
- •Prerequisite commands or setup
- •Command sequence with dependencies between steps
- •Expected output at each step
- •Checkpoints for user validation
Then produce output using TEMPLATES.md. Validate with RUBRIC.md.
Workflow
- •Define the end state: what will the user have accomplished?
- •Identify prerequisites: auth, installation, data, permissions.
- •Map the command sequence with dependencies.
- •Determine checkpoints: where can the user verify progress?
- •Write each step with command, explanation, and expected output.
- •Add troubleshooting for likely failure points.
- •Provide cleanup commands if tutorial creates resources.
- •Run the rubric check. Revise until it passes.
Degrees of freedom
Medium freedom
- •Default: follow templates for step structure
- •Allowed variation: complexity may adapt to audience; optional advanced paths permitted; troubleshooting depth may vary
State awareness
Tutorial flows must track user state:
- •Not started: Prerequisites clear, environment ready
- •In progress: Each step builds on previous
- •Checkpoint: User can verify correct state
- •Diverged: User deviated, needs recovery path
- •Completed: End state achieved, cleanup offered
References
- •Templates: TEMPLATES.md
- •Rubric: RUBRIC.md
- •Examples: EXAMPLES.md
- •Tutorial structure patterns: reference/tutorial-patterns.md