Final Report
The deadline for submitting the final report is 12 November, 2015, 2359.
What should be included in the final report?
The final report should contain at least the following sections (sections marked with [*] are new):
- Introduction
- What is the motivation behind this project?
- What is the overall vision or goal of this project?
- Software Requirement Elicitation
- What activities did you perform to gather/validate the requirements of your project? Include the details (e.g., for user survey, you can mention the questions you asked, who the participants of the survey are, what did you find from the survey, etc). If it gets too long, put the details in the appendix.
- Software Requirements
- What are the requirements (functional, non-functional) of the project?
- Remember to include the abuser stories/misuse cases and highlight how you mitigate these with your requirements.
- Software Architecture and Design
- What is the architecture of the software you are going to build? What are the components? how they interact with each other?
- What are some major design/implementation decisions that you have made? How did you come about making those decisions? (you may include the QOC)
- [*] What does the interface looks like? How did you evaluate and improve the usability of your project?
- [*] Software Planning and Project Management
- How did you prioritize the tasks? plan your sprint? assign tasks to team members?
- What tools do you use for group communication and management? (provide links)
- What is the workflow for development? (commit, branching, code review, pull, etc)
- [*] Software Implementation and Testing
- What has been implemented so far?
- How much testing has been done? How is it done? (please show evidence)
- How is code review practiced in the team? (please show evidence)
What makes a good report?
A good report would be something that is well structured, clearly written, and easy to read. Use figures, tables, cross-references, when necessary. The content should flow smoothly from one section to another, with connections between chapters and sections.
The report should NOT be just a concatenation of all your Google Drive documents. Although what you have written so far will constitute a large chunk of the content, care should still be taken to connect all the dots and link the different sections together.
Is the report graded?
The final report will be factored into your CA3 grade.
How to submit the report?
You should submit a single PDF file named team-final.pdf, where team is the name of your team in CamelCase, in one word, into a IVLE workbin that has been created. You only need to submit one copy of the report per team.