2
Understanding Different Types of Documentation in Software Development
Chapter 1 of this book looked at why you and your project or product should even care about documentation. With the convincing and scene setting complete, it’s time to start looking at the mechanics of good documentation, starting with the types of documentation you might need to create.
The simplest documentation can be a single README file in a code repository, while the most complex could be a series of interconnected sections, topics, and sub-projects. As documentation expands into more complex territory, it’s likely to need different sorts of pages that cover different purposes and have different structures. This chapter covers the common section types you might typically ...
Get Technical Writing for Software Developers 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.
