Document Catalog

This catalog is the fastest way to understand what each technical document is for and when it should be opened.

Product-Facing Documents

Document	Scope	When to use it
Product specification	Full product definition, current scope, constraints, decisions	When you need to know what the product is supposed to do
Product roadmap	Future sequencing, priorities, dependencies, entry criteria	When you need to know what comes next and why
English product specification	English mirror of the product definition	When working with English-speaking stakeholders
English product roadmap	English mirror of the roadmap	When discussing planning in English

Core Technical Documents

Document	Scope	When to use it
Bond engine architecture	Boundaries between selection, form state, engine, output, and future assistant flow	Start here when you need the big technical picture
Analysis models architecture	Interpretation layer above the canonical result for progression, liquidation, and future analytical models	Open before adding alternative result interpretations or analytical modes
Result model contract	Canonical output contract between engine, UI, export, and future persistence	Open before changing result semantics or adding new output consumers
Data and persistence contracts	Saved-simulation and prediction snapshot boundaries for future stages	Open before designing Stage 2/3 storage or reconstruction flows
Annual accumulation logic	Shared family for products with annual capitalization and payout at maturity	Open before changing TOS, EDO, ROS, or ROD behavior
Annual payout logic	Shared family for products with annual payouts without accumulation	Open before changing payout-style products using annual payout patterns
Telemetry worker	Anonymous event collection, deployment, inspection, reset	Open when touching operational analytics

Product-Specific Strategy Documents

Document	Scope	When to use it
OTS / ODS logic	3-month product and reinvestment cycle logic	For quarter-cycle behavior and historical naming notes
ROR logic	Monthly payout strategy for yearly floating-rate product	For monthly-interest product changes
DOR logic	Monthly payout strategy for 2-year floating-rate product	For DOR-specific strategy or tests
TOS logic	3-year fixed annual accumulation	For fixed-rate annual capitalization behavior
COI logic	Inflation-indexed annual payout product	For COI-specific annual payout behavior
EDO logic	10-year annual accumulation with inflation indexing	For long-cycle indexed accumulation behavior
ROS logic	Family-bond annual accumulation, 6-year cycle	For ROS-specific family-bond rules
ROD logic	Family-bond annual accumulation, 12-year cycle	For ROD-specific family-bond rules

Reading Order Recommendation

1. Product specification
2. Product roadmap
3. Bond engine architecture
4. Analysis models architecture when the feature changes how results should be interpreted rather than only rendered
5. Result model contract
6. Data and persistence contracts
7. Relevant family logic document
8. Relevant product-specific logic document
9. Telemetry worker if the task touches operations or anonymous analytics

Internal-Only Materials

Architecture audits, review findings, refactor plans, and closure notes are kept in the repository as internal engineering materials and are intentionally excluded from the published documentation site.