From a569313e14240e861b838cd6e14fa5c7645aacee Mon Sep 17 00:00:00 2001 From: Jeroen Schweitzer Date: Fri, 13 Mar 2026 14:46:00 +0100 Subject: [PATCH] docs(docs): add frontmatter templates for docs/ directory New template system for project documentation with standardized frontmatter (title, description, type, status, decision_refs). Templates for architecture, design, briefing, workshop, and test-plan document types. Enables context-aware loading alongside the existing wiki template system. Co-Authored-By: Claude Opus 4.6 --- docs/_templates/architecture.md | 41 +++++++++++++++++++++++++++++++++ docs/_templates/briefing.md | 32 +++++++++++++++++++++++++ docs/_templates/design.md | 35 ++++++++++++++++++++++++++++ docs/_templates/test-plan.md | 28 ++++++++++++++++++++++ docs/_templates/workshop.md | 35 ++++++++++++++++++++++++++++ 5 files changed, 171 insertions(+) create mode 100644 docs/_templates/architecture.md create mode 100644 docs/_templates/briefing.md create mode 100644 docs/_templates/design.md create mode 100644 docs/_templates/test-plan.md create mode 100644 docs/_templates/workshop.md diff --git a/docs/_templates/architecture.md b/docs/_templates/architecture.md new file mode 100644 index 000000000..745e1e2dc --- /dev/null +++ b/docs/_templates/architecture.md @@ -0,0 +1,41 @@ +--- +title: "" # Display name (e.g., "Fog Shader Architecture") +description: "" # One-line summary for context filtering (e.g., "How fog-of-war rendering works: texture pipeline, shader, and performance") +type: architecture # architecture | design | briefing | workshop | test-plan | test-report | audit +status: active # active | draft | archived | superseded +ticket: "" # Ticket reference (e.g., "#430") +decision_refs: [] # e.g., [D-059, D-015] +author: "" # Primary author agent or person +created: YYYY-MM-DD +updated: YYYY-MM-DD +--- + +# {Title} + +## Overview + +{What this system/component is, why it exists, how it fits into the architecture.} + +--- + +## Current State + +{What is implemented now, what changed since the original design.} + +--- + +## Design + +{Technical details: data flow, interfaces, algorithms, constraints.} + +--- + +## Decision References + +{Link to relevant D-records and explain how they constrain this design.} + +--- + +## Open Questions + +{Anything unresolved. Link to Q-records if filed.} diff --git a/docs/_templates/briefing.md b/docs/_templates/briefing.md new file mode 100644 index 000000000..2559cd133 --- /dev/null +++ b/docs/_templates/briefing.md @@ -0,0 +1,32 @@ +--- +title: "" # Display name (e.g., "Gestalt - Project Briefing") +description: "" # One-line summary for context filtering (e.g., "Systems design agent context: v0.2 pivot, generator-first, relevant decisions") +type: briefing # architecture | design | briefing | workshop | test-plan | test-report | audit +status: active # active | draft | archived | superseded +agent: "" # Agent name this briefing is for +updated: YYYY-MM-DD +--- + +# {Agent} - Project Briefing + +## Current Project State + +{High-level project status and direction.} + +--- + +## Key Changes for Your Role + +{What's changed since the last briefing that affects this agent's work.} + +--- + +## Relevant Decisions + +{Bulleted list of D-records this agent needs to know about.} + +--- + +## Current Sprint Tasks + +{What this agent should focus on now.} diff --git a/docs/_templates/design.md b/docs/_templates/design.md new file mode 100644 index 000000000..4c55f3b40 --- /dev/null +++ b/docs/_templates/design.md @@ -0,0 +1,35 @@ +--- +title: "" # Display name (e.g., "Monologue Content Architecture") +description: "" # One-line summary for context filtering (e.g., "Authoring contract for internal monologue: categories, triggers, volume targets") +type: design # architecture | design | briefing | workshop | test-plan | test-report | audit +status: active # active | draft | archived | superseded +ticket: "" # Ticket reference (e.g., "#253") +decision_refs: [] # e.g., [D-016, D-032] +author: "" # Primary author agent or person +created: YYYY-MM-DD +updated: YYYY-MM-DD +--- + +# {Title} + +## Purpose + +{What this document defines and who should use it.} + +--- + +## Specification + +{The design itself: rules, formats, examples, constraints.} + +--- + +## Examples + +{Concrete examples showing correct usage.} + +--- + +## Decision References + +{Link to relevant D-records and explain how they constrain this design.} diff --git a/docs/_templates/test-plan.md b/docs/_templates/test-plan.md new file mode 100644 index 000000000..9924b2d2e --- /dev/null +++ b/docs/_templates/test-plan.md @@ -0,0 +1,28 @@ +--- +title: "" # Display name (e.g., "Fog Rendering Visual Test Plan") +description: "" # One-line summary for context filtering (e.g., "Test coverage for fog shader: gradient smoothness, alpha tuning, performance budgets") +type: test-plan # architecture | design | briefing | workshop | test-plan | test-report | audit +status: active # active | draft | archived | superseded +ticket: "" # Ticket reference +system_under_test: "" # What system/feature is being tested +created: YYYY-MM-DD +updated: YYYY-MM-DD +--- + +# {Title} + +## Scope + +{What is being tested and what is excluded.} + +--- + +## Test Cases + +{Numbered test cases with expected results.} + +--- + +## Environment + +{Test environment requirements: live server, fixtures, headless, etc.} diff --git a/docs/_templates/workshop.md b/docs/_templates/workshop.md new file mode 100644 index 000000000..ae40eeca6 --- /dev/null +++ b/docs/_templates/workshop.md @@ -0,0 +1,35 @@ +--- +title: "" # Display name (e.g., "Where's the Fun? Workshop") +description: "" # One-line summary for context filtering (e.g., "Multi-agent workshop on v0.2 direction: tycoon bookmark, generator-first, 24 decisions") +type: workshop # architecture | design | briefing | workshop | test-plan | test-report | audit +status: active # active | draft | archived | superseded +participants: [] # Agent names involved +rounds: 0 # Number of discussion rounds +decisions_produced: [] # D-records produced (e.g., [D-114, D-117]) +created: YYYY-MM-DD +updated: YYYY-MM-DD +--- + +# {Title} + +## Brief + +{What question this workshop set out to answer.} + +--- + +## Participants + +{Who was involved and what role each played.} + +--- + +## Outcomes + +{Key decisions made, with D-record references.} + +--- + +## Open Items + +{Anything deferred or unresolved.}