Expert Python Programming - Third Edition

Summary

In this chapter, we have discussed an approach that should make documentation management an organized, lightweight, efficient, and (hopefully) fun process. We started from the seven rules of technical writing that apply to any kind of technical writing—not only documentation. From there, we have introduced tools and techniques that convert these simple rules into a clear and organized engineering process.

One of the hardest things to do when documenting a project is to keep it accurate and up-to-date. The only way to make this happen is by treating it is as a first-class engineering artefact. Good documentation is always close to the code it documents. Making the documentation part of the code repository makes this a lot easier. From ...