ITI8740 Final Documentation

Allikas: Kursused
Redaktsioon seisuga 15. detsember 2019, kell 19:39 kasutajalt Verrev (arutelu | kaastöö) (Uus lehekülg: 'Description of final project documentation The purpose of documentation is to understand the system, how to use it and if needed how to develop it further. You should already ha...')
(erin) ←Vanem redaktsioon | Viimane redaktsiooni (erin) | Uuem redaktsioon→ (erin)
Mine navigeerimisribale Mine otsikasti

Description of final project documentation

The purpose of documentation is to understand the system, how to use it and if needed how to develop it further. You should already have created most of the documentation during the course and the primary focus is packaging it into single document. The documentation should be uploaded to Gitlab and link provided to the lecturer via Slack direct message by Monday, December 23, 14:00.

The documentation should be presented either in English or Estonian and must contain the following:

  • General information about the project:
    • Team members and roles
    • A link to issue tracker and source code
    • A link to the application on web and/or appstore
  • Project background
    • General information about the project (purpose, scope, goals), 1 A4 max
    • The most recent lean canvas
    • A list of project features and requirements
    • A list to scienticic articles being used
  • Validation
    • A brief summary how validation was performed, method, results and conclusions
    • If you have any quantitative data, links to surveys etc. provide it here
  • Implementation
    • A list of implemented features and description of primary functionality
    • Installation manual (if needed)
    • User manual (if needed)
  • Project summary
    • Max 1 A4 summary that describes what goals where met and what were not, if the inital idea changed then how. What would be the next steps.