Documenting microservices
Documenting microservices is essential because it helps:
- Fellow developers understand our code when they need to modify it or provide third-line support.
- Us when we later change our code.
- System administrators install and configure our microservices application.
- Users to work with our application.
Depending on the requirements, documentation can be extensive and include a complete set of how-to guides and a reference. But at least make sure that you cover the following documentation:
- Code comments to help yourself and other developers understand your code.
- A
READMEfile to help others to install and use your software. - A RESTful API reference to help others to work with the API.
Let’s examine these documentation types into more detail.
Provide code comments
Commenting code helps you remember why you developed your code like you did. And it helps other developers understand your code when they need...
