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 <noreply@anthropic.com>
This commit is contained in:
2026-03-13 14:46:00 +01:00
co-authored by Claude Opus 4.6
parent f20c11a5a9
commit a569313e14
5 changed files with 171 additions and 0 deletions
+41
View File
@@ -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.}
+32
View File
@@ -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.}
+35
View File
@@ -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.}
+28
View File
@@ -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.}
+35
View File
@@ -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.}