21.5. Help files without tears

Software Engineering and Computer Games is about software engineering and about games development. As part of the package, you need to learn how to make a fully complete program all on your own. This means you need some minimal knowledge about how to make a help file, that is a file that users can read from within your program.

We’ve already mentioned that from the earliest build on, your program should always include a User’s Guide. And that it’s crucial to discipline yourself to do this. Working on the User’s Guide should go hand-in-hand with working on your project specification.

It turns out that you can use the very same text file as ‘source’ for both a print version of the User’s Guide and a corresponding ...

Get Software Engineering and Computer Games now with O’Reilly online learning.

O’Reilly members experience live online training, plus books, videos, and digital content from 200+ publishers.