programming-for-dummies

288
Writing Software Documentation
Help files can be read like a book, browsed through like a dictionary, or
searched like a search engine that returns pages of related information. Like
ordinary user manuals, help files often require the aid of programmers to
explain and verify that the explanations in the help files are accurate and
complete.
To make creating help files easier, many programmers use special help file
creation programs, which can turn an ordinary user manual into a help file.
By using such tools, programmers don’t have to create user manuals and
help files separately; they can just create a user manual and then turn that
user manual into a help file. Ultimately, any form of documentation is meant
to help explain what a program does and how it works. When writing documentation
for your program, make it easy on yourself and write as little as
possible while trying to be as complete as possible. It’s not an easy task, but
it’s a necessary one.