SecondBrain/_templates/convention.md

1.6 KiB

type: convention title: [Human-readable title] summary: [1-2 sentences answering "When I encounter X, what rule should I follow, and why?"] tags: - type/convention - 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 related: - [note-slug] # cross-links to companion notes; omit if none source: [project name] # project that spawned the note

[Convention Name]

Purpose

Core Principles

1. [Principle stated as a rule]. [Rationale — why this rule exists and what following it buys you.]

Patterns

[Pattern name]. [What to do, concretely.]

Anti-Patterns

  • [Smell / thing to avoid] → [why it is wrong, or what to do instead]

Exceptions

[Case]. [Why the convention bends or does not apply here.]