Developer documentation
So far, we've looked at the different kinds of tests a microservice can have, and we've mentioned that the documentation should evolve with the code. We are talking here about developer documentation. This includes everything a developer should know about your microservices project, most notably:
- How it is designed.
- How to install it.
- How to run the tests.
- What are the exposed APIs and what data moves in and out?
People go to documentation to get their questions answered. There are Who, What, Where, When, Why, and How questions, such as:
- Who should use this software?
- What does this software do?
- Where can it be deployed?
- When is using it helpful?
- Why does it work this way?
- How do I install and configure it?
Good documentation describes why decisions were made so that people—including yourself—returning to the code can decide whether a decision made...
