# Tutorial Brief

Design a testable tutorial with explicit prerequisites, safe steps, expected results, decision points, recovery options, and practical troubleshooting.

## Usage note

Use this brief before drafting a procedure that readers are expected to follow. Test the finished path in the declared environment with a clean starting state and record what changed. High-risk operations require qualified review, explicit backups or rollback, and stronger safeguards than this editorial template alone can provide. Never hide destructive effects inside a convenient copy-and-paste command.

## How to use this template

1. Define one observable outcome and the exact reader, environment, version, and starting state.
2. Inventory prerequisites, permissions, costs, risks, sample data, and required backup or rollback.
3. Draft small ordered actions with expected results and explicit decision points.
4. Test the full procedure from a clean state, then test recovery for the most likely failures.
5. Revise from tester notes and record an owner, review date, and change triggers.

## Blank template

### Outcome and setup

- **Tutorial outcome:** [One result the reader can verify]
- **Intended reader:** [Knowledge and task]
- **Supported environment:** [Platform, product, version, region]
- **Estimated time:** [Include waiting time]
- **Cost or quota impact:** [Free, paid, or usage effect]
- **Prerequisites:** [Accounts, files, knowledge, tools]
- **Permissions needed:** [Role or access]
- **Starting state:** [What must already exist]
- **Success check:** [Observable final result]

### Procedure plan

- **Step 1:** [Action] — **Expected:** [Visible result]
- **Step 2:** [Action] — **Expected:** [Visible result]
- **Decision point:** [Condition] — **Choose:** [Path A or B]
- **Step 3:** [Action] — **Expected:** [Visible result]
- **Verification:** [Command, screen, or output]
- **Cleanup:** [Remove samples or temporary resources]
- **Rollback:** [Return safely to the starting state]

### Test and safety checks

- [ ] Every command and interface label was tested in the stated version.
- [ ] Placeholders cannot be confused with real secrets or identifiers.
- [ ] Warnings appear before the action that creates risk.
- [ ] Expected results help readers detect an early wrong turn.
- [ ] Troubleshooting connects symptoms to diagnostics and recovery.
- [ ] Images have useful alternative text and do not carry all instructions.
- [ ] A fresh tester completed the guide without private help.
- [ ] Update ownership and retest triggers are recorded.
