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 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.