Service Blueprint Template¶
Use this template to document a candidate service before it is scaffolded. It complements - and does not replace - the microservice template and platform documentation template. Copy the section below and fill it in.
Template¶
# <Service Name> (CS-SVC-XXXX)
- **Category:** <category # and name>
- **Bounded context:** <context>
- **Classification:** <Platform Product | Microservice | Module-in-service | ...>
- **Runtime candidate:** <standalone | module within X service>
- **Tier / Wave:** Tier <0-5> / Phase <0-6>
- **Status:** <Live | Documented | Planned>
## Purpose
One paragraph: what problem this solves and for whom.
## Domain
- Aggregates: <list>
- Owned data: <what it owns; no shared DB>
- Domain events: <events emitted>
## Interfaces
- APIs (contract-first): <REST/gRPC/GraphQL endpoints>
- Consumed events: <events subscribed>
- Published events: <events emitted>
## Dependencies
- Upstream: <contexts/services it depends on>
- Downstream: <consumers>
## Non-Functional
- Multi-tenancy & editioning: <how>
- Security: <authN/Z, secrets, data classification>
- Compliance: <audit, privacy, regulatory>
- Observability: <traces/metrics/logs/SLOs>
- Resilience: <retries, idempotency, fallbacks>
## MVP vs Future
- MVP scope: <minimum>
- Future: <later>
## Open Questions
- <questions / assumptions; mark draft if inferred>