Documentation
Train.md Engineering Documentation
This section contains architecture and engineering artifacts that guide how we design, build, and evolve Train.md.
Documentation Categories
| Category | Purpose | Key Artifacts |
|---|---|---|
| Strategy | Align on what and why before coding | RFCs, TDDs |
| Architecture | Visualize system structure at multiple zoom levels | C4 diagrams |
| Behavior | Document runtime interactions and data flows | Sequence diagrams |
| Decisions | Record architectural choices and rationale | ADRs |
Philosophy
“Consensus before code” — We invest in upfront alignment to reduce rework and ensure shared understanding across the team.
How to Use These Docs
- Starting a new feature? Begin with an RFC to build consensus
- Ready to implement? Write a TDD for technical details
- Need to explain the system? Use C4 diagrams at the right zoom level
- Made a key decision? Capture it in an ADR