Documentation and Submission Guidelines

  1. Make sure documentation is in .pdf format unless otherwise indicated by your instructor.
  2. If you have multiple files please zip them together into one file for submission. DO NOT zip a single PDF file submission!
  3. File name format: 167_LAB1_DAVE.SMITH.pdf (or .zip). If you are working in a group please include all names in the filename ie. LAB1_DAVE.SMITH_JOHN.DOE.pdf 
  4. Even if you are working in pairs or groups you each need to submit documentation so I can grade properly, it can be the exact same document but make sure each person submits! Unless notified otherwise.
  5. Make sure your submission includes a title page with the aspects below and an introduction to start your document
    1. Course Name and Code
    2. Title (Project title)
    3. Name (All names if in pairs or group)
    4. Date
  6. Include an objective or executive summary at the beginning of your document, explaining what the document is for and it is intended target audience.
  7. Include a "Conclusion" or "Concluding Remarks." section at the end and use Section Headings through-out to organize different parts of the documentation. 
  8. Include page numbers and a table of contents.1
  9. Submissions MUST be free of spelling and grammatical errors.
  10. Figure labels for screenshots and pictures should be below the object be numbered and include a brief description.
  11. Screenshots should not be by themselves, they should have a supporting paragraph or sentence, explaining why they are there.
  12. Screenshots and content within your document, should be of your own content and screen captures. Do not represent other material as your own.
  13. If you are pasting text make sure you format the font the same as the rest of the document.
  14. Cite your resources/references in the proper MLA format (instructions).

Please take a look at some of the example documentation in the portal in the general section of your course.


1 Table of contents is required, if the document is over 3 pages in length.

Last modified: Sunday, 7 April 2024, 8:29 AM