Overview
Every Silver Bullet project gets a documentation architecture scaffolded by /silver:init. The scheme is designed around three principles:
- Docs are artifacts, not afterthoughts — every document is produced by a specific workflow step and reviewed by the artifact reviewer framework
- No doc grows unbounded — every file uses one of five scalability patterns with enforced size caps
- Separation of concerns — planning artifacts (
.planning/) are ephemeral per-milestone; project docs (docs/) are durable across milestones
docs/doc-scheme.md file with the full reference. This page explains the concepts behind it.Three Layers
Documentation lives in three distinct layers, each with its own audience and lifespan:
Planning — .planning/
Specs, plans, reviews, verification reports. Created and consumed during the SDLC. Archived automatically on milestone completion. Managed by GSD.
Project Docs — docs/
Architecture, testing strategy, changelog, knowledge, lessons. Durable across milestones. Updated during the Documentation step of every task finalization.
Public — README.md
Project overview for external readers. Updated during finalization and release.
Scalability Patterns
Every growing document uses one of these bounded patterns to prevent unbounded file growth:
| Pattern | How It Works | Example |
|---|---|---|
| Snapshot | Overwritten each milestone; previous version archived | ARCHITECTURE.md, STATE.md |
| Capped Table | Max N rows; oldest archived when exceeded | CHANGELOG.md (50 entries), quick tasks (20 rows) |
| Rotation | File archived at line threshold; fresh file started | REVIEW-ROUNDS.md (200 lines) |
| Summary + Archive | Only current content inline; older collapsed to links | ROADMAP.md, PROJECT.md |
| Fixed | Structurally bounded by nature — never grows | TESTING.md, per-phase artifacts |
Core Files
These files are scaffolded by /silver:init and form the backbone of your project documentation:
| File | Purpose | Scalability |
|---|---|---|
ARCHITECTURE.md | Component model, layers, data flow, design principles | Snapshot |
TESTING.md | Test pyramid, coverage goals, test classification | Fixed |
CHANGELOG.md | Rolling task log — what, commits, skills, cost | Capped (50) |
knowledge/INDEX.md | Gateway index of all project docs | Fixed |
doc-scheme.md | Documentation architecture reference (this scheme) | Fixed |
Knowledge & Lessons
Project intelligence is split into two directories to separate project-specific knowledge from portable lessons.
docs/knowledge/ — Project-Scoped Intelligence
Things learned about this project: architecture patterns discovered, gotchas encountered, key decisions made, recurring patterns, and open questions. Not redundant with ARCHITECTURE.md (which captures current state, not journey) or phase CONTEXT.md files (which are single-phase and archived).
- File convention:
YYYY-MM.md— one file per month, append-only within that month, frozen after - Categories: Architecture Patterns, Known Gotchas, Key Decisions, Recurring Patterns, Open Questions
- Gateway:
knowledge/INDEX.mdlists all project docs with paths and purposes
docs/lessons/ — Portable Lessons Learned
General lessons applicable beyond this project. Written as if explaining to someone who has never seen this codebase. No project-specific file paths, feature names, or requirement IDs.
- File convention:
YYYY-MM.md— same monthly segmentation - Category taxonomy:
| Prefix | Covers | Example |
|---|---|---|
domain: | Business domain lessons | Regulations, patterns, terminology |
stack: | Language/framework/tool | Bash quirks, React patterns |
practice: | Software engineering | Config management, testing strategy |
devops: | CI, deployment, infra | Pipeline design, monitoring |
design: | UI, UX, accessibility | Component patterns, responsive layout |
knowledge/ instead.Optional Files
Created when your project needs them — not scaffolded by default:
| File | When to Create |
|---|---|
CICD.md | CI/CD pipeline exists |
API.md | First API endpoint |
DEPLOYMENT.md | First deployment |
SECURITY.md | After security audit |
CONTRIBUTING.md | Multi-contributor project |
ADR/ | Significant architecture decisions |
Size Caps
Every document has an enforced growth limit. The artifact reviewer flags violations during review rounds.
| Location | Cap | If Exceeded |
|---|---|---|
docs/*.md | 500 lines | Artifact reviewer flags for splitting |
docs/knowledge/*.md | 300 lines | Split into YYYY-MM-a.md / YYYY-MM-b.md |
docs/lessons/*.md | 300 lines | Split into YYYY-MM-a.md / YYYY-MM-b.md |
.planning/ active files | 300 lines | Milestone completion archives and resets |
When Docs Update
| Event | What Updates |
|---|---|
| Every task (finalization step) | CHANGELOG.md, knowledge/YYYY-MM.md, lessons/YYYY-MM.md |
| Architecture changes | ARCHITECTURE.md (rewritten) |
| Test infrastructure changes | TESTING.md |
| Docs added or removed | knowledge/INDEX.md |
| Milestone completion | Planning artifacts archived; tables trimmed |
| Release | README.md, root CHANGELOG.md |
Non-Redundancy Rules
Silver Bullet enforces strict non-redundancy across all documentation layers:
.planning/artifacts are the source of truth during active development —docs/files are derived summariesknowledge/captures intelligence not derivable from code or git historylessons/captures portable learnings — never duplicates project-specific knowledgeARCHITECTURE.mdis high-level design only — detailed phase designs stay in.planning/phases/CHANGELOG.mdis the task log — git log is the commit log (different granularity, no overlap)
.planning/REQUIREMENTS.md, don't copy it into docs/. Reference it. If a lesson applies beyond this project, put it in lessons/, not knowledge/. The artifact reviewer checks for cross-document duplication.FLOW 16 DOCUMENT and the workflow tracker
In Silver Bullet's composable flows architecture, documentation maps to two distinct artifacts and one dedicated path:
- FLOW 16 DOCUMENT — runs post-ship. Steps include
gsd:docs-update,engineering:documentation,engineering:tech-debt,gsd:milestone-summarywhen needed, conversation memory capture when available, andgsd:session-reportwhen needed. Produces updateddocs/and session log. This is what triggers the Documentation Scheme described on this page. - Per-instance workflow tracker — the real-time state tracking artifact for an active composition. Created when a composition begins, updated after every path completes. Records the active path, completed paths, deferred improvements, dynamic insertions, and the full composition plan. Unlike the three-layer documentation scheme (which is project-level and durable),
.planning/workflows/<id>.mdis composition-level and ephemeral — it exists for the duration of the current chain. The retired single-fileWORKFLOW.mdmodel is legacy only.
FLOW 16 is what populates the project-level docs described in this page. The per-instance workflow tracker is what gives visibility into the ongoing composition before FLOW 16 runs.
See Also
- Composable Workflow Orchestration — FLOW 16 DOCUMENT in the full 18-flow catalog and the per-instance workflow tracker
- Core Concepts — skills, hooks, enforcement layers, and the full mental model
- Verification Before Completion — how gsd:verify-work enforces quality gates
- Dev Workflow — the full development cycle, including the Documentation finalization step