Temple College
  Main>Intro to PC Operating Systems>Lab Documentation

Lab Documentation

How to Document © R. Craig Collins, 2005

Suggested steps for documenting Commands or HTML tags
  • Write out what the command or tag does
  • Write out the syntax for the command or the tag
  • Include common parameters
  • Write out examples of common uses
  • Write out how this command or tag applies to this particular lab
  • Write out the completed tag or command, substituting the particulars of the lab into the appropriate example
  • Test the proposed command or tag, and modify your documentation once the command works as you expect
Documenting Procedures
  • Write out the goal of the activity
  • Break the goal into specific steps
  • Specify outcomes
  • Write specific steps that will need to be done
  • Include specific commands, if required
  • As above, test and document your proposed solution
  • Write down specific events that occur during the process
© R. Craig Collins, 2005

We rate with RSACi. Last Updated January 11, 2005