• Include a Usage document (Readme) that explains how to use the program via command line paramters, menu commands, keyboard shortcuts, and/or mouse & button gestures

• Use a book metaphor for design documents

Include a short design document that gives a brief overview of how the program is organized

• Preface is the introduction and gives a general overview of the program
• Table of Contents shows the top-level files, classes, and routines.

For long design documents you can also include

• Chapters, more detailed information on important files, classes, and routines
• Sections, overview of each routine, it's parameters, and usage

-- ShawnDB - 16 Jun 2008
to top