6 Documenting Software
Documentation is an indispensable but often unloved part of software development. The documentation of an application can be divided into the following different levels. It differs in its target audience and its proximity to the source code.
-
User manualThis type of documentation is intended for the end users and support staff of the software and is therefore also relatively far removed from the source code of the application. A user manual is used to explain the features of the application, describe how the application can be installed if necessary, what problems frequently occur, and how they can be solved.
-
Technical specificationThe technical specification is aimed at developers, architects, and technical project ...
Become an O’Reilly member and get unlimited access to this title plus top books and audiobooks from O’Reilly and nearly 200 top publishers, thousands of courses curated by job role, 150+ live events each month,
and much more.
Read now
Unlock full access