Service documentation suite
Northwind Ingestion documentation starts with ownership, not page count
The index routes each reader to the smallest owning document and makes freshness visible.
Two-minute orientation
Northwind Ingestion accepts events, buffers them, and lands them in the warehouse. Platform owns runtime; producer teams own payload quality and retries; warehouse schema remains outside the service.
Document map
Service index
README.md
What is this and where do I start?
Current system
docs/architecture.md
How is it arranged today?
Interface
docs/api.md
How do I call it correctly?
Operations
docs/runbooks/
What do I do right now?
Support
docs/support-model.md
Who responds and when?
Learning
docs/onboarding.md
How do I prove it works?
Freshness rules
| Architecture and support | Review on every production change. |
|---|---|
| Runbooks | Review after use. |
| API | Follow the machine definition. |
| Release evidence | Belongs to named versions such as v2.0.0, never permanent stubs. |