46 lines
1.6 KiB
Markdown
46 lines
1.6 KiB
Markdown
|
---
|
||
|
|
type: howto
|
||
|
|
title: [Human-readable title]
|
||
|
|
summary: [1-2 sentences answering "How do I accomplish X?" — the task this note covers]
|
||
|
|
tags:
|
||
|
|
- type/howto
|
||
|
|
- domain/[field]
|
||
|
|
- tool/[tool] # if tool-specific
|
||
|
|
- client/[client] # if client-specific
|
||
|
|
- project/[project] # if project-specific
|
||
|
|
scope: [global|project|client]
|
||
|
|
last_updated: YYYY-MM-DD
|
||
|
|
date: YYYY-MM-DD # creation date — set once, never updated
|
||
|
|
update_note: experience-driven # keep ONLY if steps involve UIs/APIs that change frequently; otherwise delete this line
|
||
|
|
related:
|
||
|
|
- [note-slug] # cross-links to companion notes; omit if none
|
||
|
|
source: [project name] # project that spawned the note
|
||
|
|
---
|
||
|
|
|
||
|
|
# [Task Name]
|
||
|
|
|
||
|
|
## Opening
|
||
|
|
<!-- One paragraph. Do NOT restate the summary — give the when-to-reach-for-this trigger and any framing the steps assume. No background theory. -->
|
||
|
|
|
||
|
|
## Prerequisites
|
||
|
|
<!-- Checkbox list of what must be true/installed/obtained before starting; each item independently verifiable. -->
|
||
|
|
|
||
|
|
- [ ] ...
|
||
|
|
- [ ] ...
|
||
|
|
|
||
|
|
## Steps
|
||
|
|
<!-- Numbered steps. Each step = context (why/when this step) → action (the command or change) → expected result (what success looks like). -->
|
||
|
|
|
||
|
|
### Step 1: [action]
|
||
|
|
|
||
|
|
## Verification
|
||
|
|
<!-- End-to-end confirmation the whole procedure worked — concrete checks/commands and their expected output (distinct from per-step expected results). -->
|
||
|
|
|
||
|
|
## Gotchas
|
||
|
|
<!-- Known failure modes and surprises, each with how to recognize it and how to recover. Omit the section only if there are genuinely none. -->
|
||
|
|
|
||
|
|
## Related
|
||
|
|
<!-- Wikilinks to companion notes, one line each on why it is relevant. -->
|
||
|
|
|
||
|
|
- [[note-slug]] — why it is relevant
|