3.0 KiB
3.0 KiB
type: user-guide
title: [Human-readable title]
summary: [1-2 sentences answering "what mental model + gotchas does using [tool] well require?" — NOT what the tool does or a feature list]
tags:
- type/user-guide
- tool/[tool]
- domain/[field] # if applicable
- 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 — user guides update when a session finds a new gotcha or a discrepancy
related:
- [note-slug] # cross-links to companion notes; omit if none
source: [project name] # project that spawned the note
[Tool Name] — User Guide
What it is
Mental model
Nuances & gotchas
When NOT to use it / limits
Command reference
| Command | Effect |
|---|---|
[command] |
[one-line effect] |
Pointers
- [path/to/repo] — [what's there]
Related
- note-slug — why it is relevant