COMP 3000 Documentation Project

From Soma-notes
Jump to navigation Jump to search

The open source documentation project is due on November 19, 2012 @12 PM (noon). Your project should be submitted in PDF format only. Your project should contain the following:

  • Your name and the name of your partner (if any)
  • The name of the open source project you are documenting
  • The URL of the project's main development site
  • A Background section containing:
    • A description of the project you are documenting: what does the program do, what are its key features, and how does it compare to other similar programs (open source and commercial)
    • A description of the current state of its documentation
    • A description of what aspect of the program you decided to document
    • An explanation for why this is worth documenting, indicating the target audience for the documentation
    • A description for how this documentation is related to the material covered in class. What concepts and/or tools helped you develop the documentation? Is it useful for system administrators looking to install the software? You should be able to make some sort of connection between your work on this documentation and the rest of the class.
  • A Methodology section that explains how you learned what you needed to in order to produce this documentation. Here you should cite any sources and give credit to anyone who helped you. Document any difficulties you encountered. Also, explain how your view of your documentation task changed as you learned more about the project.
  • A Documentation section that includes the documentation you created on the project. If this documentation is based on pre-existing documentation in any form, clearly mark which parts of the text are your contribution and which are pre-existing.

The project will be graded out of 30 points, with the project info/Background, Methodology, and the Documentation sections each being worth 10 points. Projects will be graded on the basis of clarity, organization, writing quality (grammar/spelling), and technical content.