Document templates

Posted on

Compulsory deliverables

  • Weekly reports written with the Metrics Management Tool. Project managers write the weekly reports on Sunday or on Monday for the previous week. See also guidelines for email weekly reports.
  • Project plan (template from TUT’s TIE-13106 -course).
    • Replace Tampere University of Technology with University of Tampere, etc.
    • In Section 5.1 (Iterations), list also iteration 0 that ends when the Project plan is inspected.
  • Test report (free form, list test cases and results (test passed / failed) is enough). You can also use TUT’s Testing report document template.
  • Final report (template from TUT’s course, template link updated on 7.1.2019).
  • Project poster (A4-size pdf-document, name of the project in top, include at least one screenshot, description of the project, team member names).
  • Project CD

Supporting documents

Teams decide how they design software architecture, user interface and testing, and how they manage and document requirements.

Weekly reports

Project managers will write the weekly reports on Sunday or on Monday for the previous week using Metrics Monitoring Tool. Check also Metrics Monitoring Tool’s FAQ on weekly reporting.

As long as there are problems with the MMT tool, send weekly reports by email starting from Monday 6.5 to teacher responsible (timo.poranen at tuni.fi) and project supervisor (pekka.makiaho at tuni.fi). In the weekly report, write shortly about the following issues (change week number and dates when needed):

Title: Project name / Weekly report for week 18

  • Report period: 29.4 – 5.5.2019
  • Working hours of team members
    • List working hours of all team members for the current week and total working hours so far (example: NN 15h / 165h)
  • Tasks done during the week.
  • Tasks for the next week.
  • Challenges, risks, other issues, etc.

Project CD

The project CD / DVD / Blu-ray / Memory stick should contain a README.txt file that lists the content of the CD and the locations of the files. Your project CD should contain all your documents and code.

If the project’s documentation is in a wiki, it is ok to burn the whole wiki to the CD. You should make sure that the links in the wiki are self-explanatory, easy to follow and understand.

There should be at least the following documents:

  • README.txt
  • Project plan
  • Requirements specification (or the corresponding product backlog, use cases and other documents related to requirements management)
  • Test plan
  • Design documentation, database diagrams
  • Test report
  • Final report
  • Project poster
  • Code
  • Inspection / Review reports

And possibly

  • Project’s usability plan
  • UI specification
  • Heuristic evaluation reports
  • Usability test reports
  • User guide
  • Online help
  • Installation guidelines
  • Configuration files, makefile
  • Maintenance document
  • etc.