Tosumu Documentation Map
Tosumu separates specifications, decisions, implementation work, incoming requests, and exploratory material so that each document has one clear job.
Use the Document Status dashboard to see the authority, lifecycle, and next action for current records.
Required Status Metadata
New durable documents should identify both dimensions below near the top:
- Authority -- normative, binding, tracking, evidence, or informative.
- Lifecycle -- current, active, proposed, incubating, deferred, completed, historical, or superseded.
Authority answers whether a document can define Tosumu behavior. Lifecycle
answers whether it describes present state, active work, future work, or
history. Draft may describe editorial stability, but it does not replace
either dimension.
Authority And Purpose
| Location | Purpose | Authority |
|---|---|---|
Specifications/ |
Current design, error, and inspection contracts | Normative, except the informative reference index |
Repository-root SECURITY.md |
Security posture, limitations, and disclosure policy | Normative |
ADR/ |
Accepted architectural decisions and consequences | Binding until superseded |
Architectural Reviews/ |
Questions, evidence, alternatives, findings, and reopening triggers | Evidence record; not binding by itself |
Plans/ |
Concrete implementation slices and validation | Work sequencing only |
CRs/ |
Incoming consumer and cross-project requests | Proposed until accepted |
Notes/ |
Durable observations that are not decisions | Informative |
Conversations/ |
Preserved exploratory discussions and source material | Informative and unreviewed |
Archive/ |
Retired or superseded material retained for history | Historical |
.workbench/ |
Local audits, scratch notes, and temporary working material | Non-authoritative and gitignored |
The curated public documentation pages at the top of docs/ summarize the
current system for users. They must remain consistent with the engineering
specifications and accepted ADRs rather than becoming a second specification.
Website And Repository Publication
The public website is a curated guide and evidence surface. GitHub remains the complete engineering record.
| Public website | GitHub engineering record |
|---|---|
| Getting started, concepts, architecture, references, safety, current status, and public roadmap | Active and completed plans, unresolved reviews, CR internals, notes, conversations, templates, and archive history |
| Normative specifications and accepted ADRs under an engineering-reference area | Full evidence cycles and implementation history |
| Reviewed evidence summaries and static-first labs | Raw generated reports, audits, and exploratory inventories |
Repository records are promoted to the website by writing a stable current summary, not by making every source document part of the primary navigation. The original record remains available for readers who need the full reasoning. See the Public Website And Repository Records Plan.
Source-Of-Truth Specifications
The design, error, inspection, and reference documents live in the published
Specifications/ collection. The security policy
retains its conventional repository-root location:
docs/Specifications/Tosumu Software Design Document.md-- architecture, format, goals, and staged designdocs/Specifications/Tosumu Error Design Document.md-- public error taxonomy and behaviordocs/Specifications/Tosumu Inspect API Specification.md-- inspection contractsSECURITY.md-- security posture and limitationsdocs/Specifications/Tosumu Reference Implementations.md-- informative external references and influences
Change Flow
Observation, consumer request, or implementation pressure
↓
Note, Conversation, CR, or local workbench evidence
↓
Architectural Review when ownership or boundaries are unresolved
↓
ADR when an architectural decision is accepted
↓
Implementation Plan
↓
Code, tests, and updated public documentation
Small bug fixes and boundary-preserving refactors do not require an Architectural Review. They still require tests and documentation updates when public behavior changes.