Posted almost 2 years ago. Visible to the public. Draft.

Minimum layers for documenting services

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 service’s technical implementation, such as the programming language, major framework versions, links to supporting tools, and deployment URLs

Documentation tool

Owner of this card:

Last edit:
almost 2 years ago
by Sanjay
Posted by Sanjay to Microservices In Action
This website uses short-lived cookies to improve usability.
Accept or learn more