| name | author-tutorial |
| description | Use `author-tutorial` to get Tutorial Format when reviewing/writing tutorial or manual user step guide. |
Tutorial Format
A tutorial guide a human user to complete an assignment manually.
- Determine goal of assignment (tutorial)
- Breakdown human assignment into practical steps.
- Each step must be formatted as a subsection of tutorial section and formatted as follows:
- Must include an example command/config/user action
- Must include an example response/output (if known)
Important Tutorial Rules
- Communicate to human: Full but concise sentences, first person as guide
- Tutorial Steps must be placed in correct sequential order
- Entire tutorial must be < 400 lines (remove trivial examples if necessary)
- Where user can decide on different workflow paths, format each workflow as different subsection
- Include warnings about common pitfalls
- Use emojis to highlight important info
- Start every step title with emoji