net-kingdom/docs/tutorials/TEMPLATE.md

42 lines
737 B
Markdown
Raw Normal View History

# <Tutorial title>
Exercise status: unexercised
Workplan task: NK-WP-NNNN-TNN
Pattern(s): <canonical doc and section this teaches>
## Outcome
<One sentence: what is true when you are done.>
## Prerequisites
- <Access, tools, and state required. Name the owner of each.>
## Architecture context
<Who owns what. Which boundaries this crosses.>
## Steps
1. **[owner: <repo>]** <step and command>
## Verification
Done when:
- <Observable, repeatable check. Command plus expected result.>
## Rollback
- <How to undo each step, or "not reversible" and why.>
## Threat checks
- <What could go wrong; what must never be logged, committed, or pasted.>
## Ownership notes
| Concern | Owner |
| --- | --- |
| <concern> | <repo> |