Documentation Scheme

How Silver Bullet organizes your project's documentation across three layers — with bounded growth, no redundancy, and clear ownership.

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
Your project includes a 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:

1

Planning — .planning/

Specs, plans, reviews, verification reports. Created and consumed during the SDLC. Archived automatically on milestone completion. Managed by GSD.

2

Project Docs — docs/

Architecture, testing strategy, changelog, knowledge, lessons. Durable across milestones. Updated during the Documentation step of every task finalization.

3

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:

PatternHow It WorksExample
SnapshotOverwritten each milestone; previous version archivedARCHITECTURE.md, STATE.md
Capped TableMax N rows; oldest archived when exceededCHANGELOG.md (50 entries), quick tasks (20 rows)
RotationFile archived at line threshold; fresh file startedREVIEW-ROUNDS.md (200 lines)
Summary + ArchiveOnly current content inline; older collapsed to linksROADMAP.md, PROJECT.md
FixedStructurally bounded by nature — never growsTESTING.md, per-phase artifacts

Core Files

These files are scaffolded by /silver:init and form the backbone of your project documentation:

FilePurposeScalability
ARCHITECTURE.mdComponent model, layers, data flow, design principlesSnapshot
TESTING.mdTest pyramid, coverage goals, test classificationFixed
CHANGELOG.mdRolling task log — what, commits, skills, costCapped (50)
knowledge/INDEX.mdGateway index of all project docsFixed
doc-scheme.mdDocumentation 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.md lists 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:
PrefixCoversExample
domain:Business domain lessonsRegulations, patterns, terminology
stack:Language/framework/toolBash quirks, React patterns
practice:Software engineeringConfig management, testing strategy
devops:CI, deployment, infraPipeline design, monitoring
design:UI, UX, accessibilityComponent patterns, responsive layout
Portability rule. Lessons files must never contain project-specific references. If you can't explain the lesson without naming a project file or feature, it belongs in knowledge/ instead.

Optional Files

Created when your project needs them — not scaffolded by default:

FileWhen to Create
CICD.mdCI/CD pipeline exists
API.mdFirst API endpoint
DEPLOYMENT.mdFirst deployment
SECURITY.mdAfter security audit
CONTRIBUTING.mdMulti-contributor project
ADR/Significant architecture decisions

Size Caps

Every document has an enforced growth limit. The artifact reviewer flags violations during review rounds.

LocationCapIf Exceeded
docs/*.md500 linesArtifact reviewer flags for splitting
docs/knowledge/*.md300 linesSplit into YYYY-MM-a.md / YYYY-MM-b.md
docs/lessons/*.md300 linesSplit into YYYY-MM-a.md / YYYY-MM-b.md
.planning/ active files300 linesMilestone completion archives and resets

When Docs Update

EventWhat Updates
Every task (finalization step)CHANGELOG.md, knowledge/YYYY-MM.md, lessons/YYYY-MM.md
Architecture changesARCHITECTURE.md (rewritten)
Test infrastructure changesTESTING.md
Docs added or removedknowledge/INDEX.md
Milestone completionPlanning artifacts archived; tables trimmed
ReleaseREADME.md, root CHANGELOG.md

Non-Redundancy Rules

Silver Bullet enforces strict non-redundancy across all documentation layers:

  1. .planning/ artifacts are the source of truth during active development — docs/ files are derived summaries
  2. knowledge/ captures intelligence not derivable from code or git history
  3. lessons/ captures portable learnings — never duplicates project-specific knowledge
  4. ARCHITECTURE.md is high-level design only — detailed phase designs stay in .planning/phases/
  5. CHANGELOG.md is the task log — git log is the commit log (different granularity, no overlap)
Never duplicate between layers. If content exists in .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-summary when needed, conversation memory capture when available, and gsd:session-report when needed. Produces updated docs/ 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>.md is composition-level and ephemeral — it exists for the duration of the current chain. The retired single-file WORKFLOW.md model 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