Middle+
What documentation do you write when developing a new service?
sobes.tech AI
Answer from AI
When developing a new service, I usually write the following documentation:
- Technical Specification (TS) — description of the service's goals, functionality, and requirements.
- Architectural Description — diagram of components, interactions between them, used protocols, and technologies.
- API Documentation — description of endpoints, request and response formats, usage examples (often with Swagger/OpenAPI).
- Deployment Instructions — how to build, configure, and run the service in different environments.
- Operational Guide — monitoring, logging, error handling.
- Testing Documentation — description of test scenarios, coverage, tools used.
This set helps the team quickly understand the service, maintain, and develop it.