Prev Up
Go backward to Projects, Teams, and Meeting Schedule
Go up to Project

Documentation Requirements and Guidelines

How should generic software be documented? This is a discussion of the problem in general, plus some specific requirements for the project reports for this course. We start with a general discussion that mostly applies to nongeneric as well as generic software components.















  • User documentation vs. design documentation vs. code documentation
  • User documentation of generic software components
  • Specifying concepts
  • Specifying functions
  • When it may be necessary to explain design decisions
  • Tips
  • Contents and organization of project final reports
  • User's guide
  • Intended audience
  • Level of discussion
  • Defining terms
  • Tutorial material
  • Reference manual
  • Design issues
  • Source code
  • Test plan and results
  • Other essential steps in preparing your report

  •  

    Prev Up