Skip to content

e36: Documentation Deduplication — provenance pointers, not restatements #31

Description

@danielvm-git

Epic e36: Documentation Deduplication

WSJF: 1.4 · BCP: 10 · Stories: 4
Source: specs/DEEPEN-ARCHITECTURE-REVIEW.md §5.5

Convert reference docs from restating principles to provenance pointers. CONVENTIONS.md becomes the single source of truth. Eliminate hub-and-spoke duplication.

Stories

# BCP Title
e36s01 3 Convert docs/references/uncle-bob.md from restating principles to provenance pointer (~10 lines: source, key ideas, map to CONVENTIONS.md sections)
e36s02 3 Convert docs/references/akita.md, ousterhout.md, karpathy.md, wasowski.md to provenance pointers
e36s03 2 Remove F.I.R.S.T rubric restatement from enforce-first/SKILL.md and audit-code/SKILL.md; replace with "See CONVENTIONS.md §Tests (F.I.R.S.T)"
e36s04 2 Update docs/references/spec-kit.md to cover full SDD tool landscape (Kiro, spec-kit, Tessl, BMAD, GSD, bigpowers) with Fowler's SDD framing

Why

The same principles (F.I.R.S.T, Boy Scout Rule, SRP, DRY) are restated in 4-6 places with slight drift. When a principle changes, you have to find and update all copies. Provenance pointers eliminate the drift risk.

Target State

Each reference doc is ~10 lines:

# Source
Clean Code, Robert C. Martin, 2008

# Key Contributions
- Boy Scout Rule: leave code cleaner than you found it
- F.I.R.S.T tests: Fast, Independent, Repeatable, Self-Validating, Timely
- Intention-revealing names

# Encoded In
- CONVENTIONS.md §Code Style and §Tests
- docs/references/uncle-bob.md

Prerequisite

Lowest urgency — ship last among deepening epics. No dependency on other epics, but benefits from golden suite (e31) to verify no regressions.

Definition of Done

  • uncle-bob.md < 20 lines
  • akita.md, ousterhout.md, karpathy.md, wasowski.md < 30 lines each
  • F.I.R.S.T rubric appears in CONVENTIONS.md only (not in SKILL.md bodies)
  • spec-kit.md covers Kiro, Tessl, BMAD, GSD alongside bigpowers

Metadata

Metadata

Assignees

No one assigned

    Labels

    deepening-releasev2.45.0 Deepening release epicsdocumentationImprovements or additions to documentationepicA major initiative composed of multiple stories

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions