Type | Summary |
---|---|
Overview | An overview of the service’s purpose, intended usage and overall architecture. Service overviews should be an entry point for team members and service users. |
Contract | A service contract should describe the API that a service provides. Depending on transport mechanism, this can be machine-readable, for example, using Swagger (HTTP APIs) or protocol buffers (gRPC). |
Runbooks | Documented runbooks for production support detailing common operational and failure scenarios |
Metadata | Facts about a servi... |
Section | Purpose |
---|---|
Problem & Context | What technical and/or business problem does this feature solve? Why are we doing this? |
Solution | How are you intending to solve this problem? |
Dependencies & Integration | How does it interact with existing or pl... |