CHAPTER4

Designing Intelligent Documentation

Most organizations overlook the value of documentation and its role in accelerating and improving the quality of the applications and the efficiency of an operations team. Documentation is commonly viewed as something that slows Web development down. If used intelligently, however, it can be a powerful tool for enhancing the quality of code, the operational processes, and the overall efficiency of information technology teams.

Documentation is a critical part of the software development life cycle. It is just as important as testing and quality assurance. If you can’t articulate how your application or operations process works or how someone can replicate the steps you took, other engineers will ...

Get Pro Website Development and Operations: Streamlining DevOps for large-scale websites now with O’Reilly online learning.

O’Reilly members experience live online training, plus books, videos, and digital content from 200+ publishers.