Creating Effective Documentation
Many developers consider documentation as a burden rather than a meaningful activity. This is comprehensible since often enough, the documentation is not updated anymore after it has been written. Soon, it is full of wrong statements and outdated information, which is indeed something that nobody wants.
We are convinced that documentation is too important to abandon it. If done right, it will be a valuable addition and an important building block for writing clean code, especially when Working in a Team.
Therefore, in the last chapter of this book, we want to give you some ideas about how to write documentation that is practical and maintainable.
We are going to cover the following main topics in this chapter:
- Why documentation matters
- Creating documentation
- Inline documentation