ENGG4930D Course Project Submission Guideline

This is an example repository for students who are taking ENGG4930A/B/C/D to submit their course project here. Each team is required to write a README.md file for documenting the structure and purpose of files uploaded to the repository. Your repository should follows the recommended naming convention.

• coursecode-projectname-documentation for documents or multimedia submission
• coursecode-projectname for coding projects (optional for teams that do not required coding)

A list of files that should consist of:

Final Report

This report will likely be the key (or even only) document where students can pick up where you have left off. So you need to pass over all related files to us to be uploaded to SIGHT’s GitHub, such as detailed description of your prototype, software codes with comments (if coding was involved), design files (pictures and figures to illustrate your prototypes, 3D modelling files), user manuals, results of user tests, feedback from partners, etc.

Your final report will be submitted here in the outter most directory and the grading scheme is shown as follows:

Item	Grade
Introduction to the project, Objectives and User Needs (15%)
Design Solutions (40%) The evolution of the product The evaluation of the final prototype Technologies involved in the product How it is meeting the needs of the end user Problems they had and how did they overcome those? Sustainability Sufficient information provided to carry this project in the future Sufficient images and figures for explanations
User Experience (30%) How did they contact user to get feedbacks and comments? How often did they contact them? What are the changes they have done to the product based on user feedbacks? How the user feedbacks help to have a better, sustainable solution
Implementation Plan/ Future plan, recommendations and conclusion (15%) What are the short term (less than 3 months) and long term plan for the project (Should have a clear and feasible timeline) How is the product going to reach the end user? In-line with local customs

Design Files

This should includes any sketches or drawings of your prototype to demonstrate showcase the design or schematics for either the software user interface or hardware dimensions and its specifications.

Documentation for contributors

This section is about the longevity/prospect of the future development of your project, any documentations to welcome and help onboarding future contributors to the project (i.e a Getting Started guide)

Supporting files

This can be 3D model files, presentation slides, explanatory video (walkthrough guide) or instruction manual for how to use your product/prototype. Any other materials that are relevant to the project in general.

Open Source License and Creative Commons

You can get your project licensed on GitHub with the following options of different licensing model from Creative Common, simply put up the markdown file of the license you choose in the root of your project.

• BY – Attribution
• BY-NC – Attribution-NonCommercial
• BY-NC-ND – Attribution-NonCommercial-NoDerivatives
• BY-NC-SA – Attribution-NonCommercial-ShareAlike
• BY-ND – Attribution-NoDerivatives
• BY-SA – Attribution-ShareAlike
• CC0 – CC0

Example

MedEasy

MedEasy is a mobile clinic solution designed to help managing electronic health records for doctors and physicians who works at the clinic and does field visit at the slum in Cambodia.

This project started out as the phase 4 of an on-going development of the Easymed initiative.Easymed aims to provide a better user experience and boost the productivity and efficiency at medical related informatics in combination of hardware and software.

How to use this project

This project is structured as follow:

• Report medeasy-final-report.pdf
• Design files folder
• Supporting files folder