Skip to content

Latest commit

 

History

History

Folders and files

NameName
Last commit message
Last commit date

parent directory

..
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 

docs/ : the project's externalized memory (manifest)

Every file in docs/ must be listed here, or checks/check.mjs fails. Dynamic content (spec folders, decision records, log archives, generated standards, design references, runbooks) is covered by the patterns marked ◆. Tiers: LIVE = always current, update-or-fail; REF = current for its domain, updated when the domain changes; ARCHIVE = frozen, never cite as current.

File Tier What it owns
README.md LIVE This manifest
DESIGN.md REF Design system: principles, the owner's standing direction, this project's tokens. In docs/ because the design method reads it there without configuration
PRODUCT.md REF Product record for the design method: platform, brand commitments, evidence on hand, accessibility. Points at product/BRIEF.md for scope, users and purpose. Written by the method's own init; absent until then, and begin removes Groundwork's own
state/STATE.md LIVE Live state, session handoff, the single "what's next"
state/DEBT.md LIVE Technical debt ledger (with defer: site markers)
state/TEMPLATE-DEBT.md REF Blank debt ledger; begin puts it in place of Groundwork's own
state/INTAKE.md LIVE Untriaged feedback and ideas; nothing built from here
state/log/*.md ARCHIVE Rotated STATE.md log entries, per month
product/BRIEF.md LIVE Scope: what this project is and is not
product/VISION.md LIVE Purpose: mission, vision, who it serves, what it is deliberately not, and the numbered strategy a feature cites. Written by begin from the template; absent until then
product/TEMPLATE-VISION.md REF Blank vision skeleton; begin puts it in place as this project's own
product/TEMPLATE-BRIEF.md REF Blank brief skeleton; begin puts it in place of Groundwork's own
product/CONTEXT.md LIVE Domain glossary: shared vocabulary, banned synonyms, how a term is measured
product/ARCHITECTURE.md REF System map: modules, data, what the system decides, contracts, environments (made by architect; absent until then)
specs/TEMPLATE.md REF Spec skeleton + tier rules (S/M/L)
specs/TEMPLATE-PLAN.md REF Plan skeleton for tier L: build order, seams, rollback, verification
specs/TEMPLATE-TICKET.md REF Ticket skeleton: one vertical slice per file, session-sized
specs/[0-9]*/** LIVE Specs for changes being built (spec.md, plan.md, notes, fixtures)
specs/archive/** ARCHIVE Shipped or dropped specs; ships with one fictional worked example and Groundwork's own baseline record
decisions/TEMPLATE.md REF Decision record skeleton
decisions/[0-9]*.md REF Decision records, numbered (Groundwork's own ship with the framework)
standards/GLOBAL.md REF Universal code standards, stack-independent
standards/*.md REF The stack template with the floor table, and the per-stack standards the stack skill generates from it
design/reference/** REF Brand assets, screenshots, design references
design/VOICE.md REF Voice & content system: how the product reads
compliance/REGISTER.md LIVE This project's register: which regimes apply, status and evidence per obligation
compliance/TEMPLATE-REGISTER.md REF Blank register; begin puts it in place of Groundwork's own
compliance/COMPLIANCE.md LIVE The EU/NL regimes, when they bite, and the date each was verified
compliance/AI-LITERACY.md REF AI Act Art 4 literacy evidence: the measures, and who they cover per the register
operations/*.md REF Runbooks: deploy, incident, backup/restore, monitoring, plus the blank operations/TEMPLATE-DEPLOY.md that begin puts in place of the deploy one and operations/evidence-drill.md, which is Groundwork's own and inert in a project

Rules: one fact, one owning file; everything else links to it. New file → add a row here in the same change. Retire a fact → add its old wording to the denylist in checks/config.json.