Program Design Templates

Notes:

• All documents should include an accurate table of contents.
  • This is trivial if you know how to use the software.
  • If you are unsure of how to produce a table of contents, ask for assistance.
• If you are requested to provide a paper copy of the document, please
  • Print double sided to save paper.
  • Three hole punch your submission.
  • Submit in a binder. These can be three ring binders or folders with fasteners.
• The documents should be legible and points will be deducted if this is not the case.
  • On several occasions, the lab printer was smudging the paper. Before you submit an unreadable report due to printer problems, please contact your instructor.
• Documents should CONTAIN associated images such as structure charts and UML diagrams.
  • Incorporating an image in a word or open office document not a difficult task.
  • If you need help ask.
  • In all cases the images should be readable. If necessary, provide a top level and multiple lower level views of the diagram. This is especially true for UML documents which tend to become large.
  • If necessary rotate the image or put the page in landscape mode.
• If you do not use a portion of the document, remove it.
• Make sure that your name, class, project name, date and other identification information is correct.

Documents:

• Requirements document.
  • This document is based on the IEEE Std 830-1998 document.
  • I have modified it for local use.
• Design document.
  • This is based on a template from Professor Hillman.
  • I have modified it to suit my preferences.
• Test plan document.
  • This is based on a template from Professor Hillman.