Project Documentation: How to Guarantee Your Project Endures With High Quality
Documentation, I know, right now, you are preparing to leave this post. Documentation is not a buzzword topic, such as microservices, Kubernetes, cloud-native, etc. However, it guarantees a scalable, maintainable, and healthy project. Let’s explain how to keep a better project tactically through Documentation.
The first question around Documentation is why. Why should you spend time on Documentation instead of the code? Software development is expensive, and we must ensure this project will have a long life. To make it possible, we need to make life easier for a future engineer, who eventually might be yourself.
Therefore, good Documentation can help us:
- Make it more natural for the following developers
- Explain the reason for some decisions around the code design and, eventually, architecture.
- Avoid making the same mistake twice.
- People leave an organization, and the knowledge should not go with them.
- We don’t have the power to read people’s minds. Trust me; I tried multiple times.