@make(report) @style(spacing 1) @begin(titlepage) @begin(Titlebox) Name of Document @end(titlebox) Date Revision (if applicable) System it is part of Author(s) MIT Group it comes from @copyrightnotice(Massachusetts Institute of Technology) @end(titlepage) @chapter(Introduction) What is the thing? What does it do? (Why should reader care?) (Use very high-level explanations here) Who is expected to use it? This document will tell you... @chapter(Vital Statistics) What language is it written in? Under what system (Xenix, 4.2, DOS?) For what hardware (AT, VAX..) Any special hardware dependancies? (Color graphics? VS100?) What software does it rely on? -which libraries does it call -Penplot? NAG? Somebody's neat hack? -database systems? -which versions of those systems? -require network server access? How much memory does it take? @chapter(The Problem) What were you trying to solve? @chapter(General Approach) name the main actors, and their interactions @chapter(Data Sructures and Formats) @chapter(Tables, Queues, and Buffers) @chapter(Overview of Major Modules) main module, its name, its filename, the home directory name for the system subprograms called, what they do, what the calling sequences are @chapter(Key Algorithms) @chapter(I/0 Formats) @chapter(Error Handling, Error Messages) @chapter(Failure and Recovery) @chapter(System Test Description) @chapter(Maintenance Plan) does somebody need to nurse it? how to start it up abnormal behavior and diagnosis stop and restart @chapter(Implementation Plan) how and when worked into system what has to go away documentation plans what must be written and modified who is going to do this? announcement? consulting plans @chapter(Glossary) @chapter(References)