5.2 KiB

Raw Blame History

type: reference subtype: pattern/framework # REQUIRED — set to exactly one of: pattern/framework | api-integration | role-definitions | design-rules title: [Human-readable title] summary: [1-2 sentences answering "what facts do I need to look up to make a decision / integrate / understand roles?"] tags: - type/reference - 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 last_reviewed: YYYY-MM-DD # REQUIRED if subtype is api-integration (mutable facts: auth, endpoints, schema); otherwise delete this line related: - [note-slug] # cross-links to companion notes; omit if none source: [project name] # project that spawned the note

[Reference Title]

Purpose

Core Principles

Decision Framework

Patterns

[Pattern name]

Anti-Patterns

[Anti-pattern / smell] → [why it is wrong, or what to do instead]

Known Limitations

Setup

Authentication

Schema / Data Model

Operations

Gotchas

Roles

[Role] — [responsibility in one line]

Inputs & Outputs

Phases

Boundaries

Rules / Standards

[Rule / standard] — [the value or directive]

Examples

Exceptions

note-slug — why it is relevant

5.2 KiB Raw Blame History