Chapter 9User Support

“The skill of writing is to create a context in which other people can think.”

Edwin Schlossberg

When working with a code base, developers maintain good developer documentation, so that future developers can understand the functioning of every module and function in the code base. Earlier chapters have identified techniques for establishing and using good developer documentation.

However, software development also requires maintaining good user documentation. Such documentation connects the software to its users. It can be viewed as a technical (reference) manual of “how to’s” for using the software to perform each of the tasks that the system supports. User documentation can also act as a tutorial for beginners when they ...

Get Software Development 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.