10.03 Obsidian Documentation Flow
How documentation stays aligned with code.
AGENTS.mdin code/source folders for folder-level rulesdocs/playbook/for process/toolingdocs/reference/for architecture and researchdocs/features/for documenting work/spec
Core Rules
- AGENTS in code folders. Every top-level code/source folder needs an
AGENTS.mddescribing purpose, boundaries, entry points, and tests. - Open questions live in docs. Use
πββοΈ/π€/βcomments with block IDs. See [[playbook/10-docs/10-01-open-questions-system/SKILL]]. - Use
tk+tinychange. Create atkticket for non-trivial work and update the changelog viatinychange. Use the standard ticket template. Don't manually update the changelog. - Johnny Decimal (two-digit). Use
NN.NNfor playbook/reference IDs.
One-Shot Usage (LLM)
- Read
docs/AGENTS.mdand the closest folderAGENTS.md. - Update playbook/reference docs, not sidecars.
- Use open-questions format with block IDs.
- Record a
tkticket for non-trivial work. - Log changes:
tinychange -I new -k <fix|test|chore|security|feat|docs|refactor|perf> -m "message" -a AUTHOR
When Updating Code
- Read the nearest
AGENTS.mdin the code folder. - Update or add
AGENTS.mdif the folder's purpose/boundaries changed. (ONLY ALLOWED AFTER[OK]from the Hooman.) - If behavior changes, update the relevant docs in
docs/reference/. - Log the change via
tinychange.
Where to Document
- Process/tooling β
docs/playbook/ - Research β
docs/reference/ - Feature specs/plans β
docs/features/ - Architecture β
**/AGENTS.md
