Writing the documentation
An important part of software quality comes from noting that the product is not simply code directed at a compiler or interpreter. As we noted in Chapter 15, Designing for Testability, code that cannot be trusted cannot be used. In that chapter, we suggested that testing was essential to establishing trust. We'd like to generalize that a bit. In addition to detailed testing, there are several other quality attributes that make the code usable, and trustworthiness is one of those attributes.
We trust code in the following scenarios:
- We understand the use cases
- We understand the data model and processing model
- We understand the test cases
When we look at more technical quality attributes, we see that these are really about understanding. ...
Get Mastering Object-oriented Python now with the O’Reilly learning platform.
O’Reilly members experience books, live events, courses curated by job role, and more from O’Reilly and nearly 200 top publishers.
