Evaluation and Standardisation of Documentation: How to Make It a Tool, Not a Problem
-
20 min
Imagine walking into a library where the books are scattered and half of them are outdated. This is what our documentation looked like after we switched to microservices. We expected order, but we were faced with chaos. So, we decided to change things by developing standards to evaluate and improve documentation.
In this talk:
1. We will discuss how to create and implement a methodology for evaluating service coverage with documentation.
2. We will discuss how to digitise this metric and use it to improve documentation quality.
3. Let's talk about how to motivate the team to keep documentation up to date and integrate new standards.
4. We will share examples of successful application of the approach and the results we got.
This talk will be especially relevant to team leads and mid-level (and above) analysts looking to bring structure and value back into documentation.