Tuesday, March 8, 2011

Chapter 25 - Front Matter and End Matter in Long Documents

Cover Sheets
Should be used for long documents and center the information presented.


Title Page
Should be used to report the title, the author's name, the name of the person or organization that it's being submitted to, and the date of submittal.


Letter of Transmittal
Use as a gesture of courtesy to possibly:

  • acknowledge those who helped in the report
  • refer to sections of special interest
  • offer personal observations
  • urge the recipient to immediate action





Table of Contents
These should guide the reader to the information they are looking for. Some guidelines include:

  • List front matter, numbering in lower case roman numerals
  • Number end matter in arabic numerals continuing from page 1 of the actual report
  • Include no headings
  • Phrase headings just as in the report
  • List headings at various levels





List of Tables and Figures
When the report has four or more visuals, they should be listed on a page for Tables and Figures.




Abstract or Executive Summary
This gives the reader a quick overview of the report without having to read the whole thing. Some suggestions include:

  • Make sure it stands alone
  • Write for a general audience
  • Add no new information
  • Present in sequence of identifying the issue, offering information on it, then including a conclusion





Glossary
This page alphabetically lists terms and definitions. This page should:

  • Define unfamiliar terms
  • Define special terms
  • List all in alphabetical order
  • Be listed in table of contents



Appendices
Should be added if large blocks of the relevant information would bog down the document. This includes formulas, experiments, and samples.


Documentation
Outside sources should be listed in alphabetical or numerical order at the end of the document.





No comments:

Post a Comment