The solution documentation

From Computer Science Wiki
Internal assessment[1]

Introduction[edit]

The internal assessment is split into two parts, a group 4 project and the solution. This page describes the requirements of the product page for the solution.

Documentation Requirements[edit]

Documentation

This information must be read in conjunction with that in the “Organization of documentation” section. A zip file is available by clicking this link which contains the cover page and templates required for submitting the solution.

The final documentation consists of:

  • Information added to the Record of tasks form and in the information linked to the design overview. The information added must be in the following style(s):
    • bullet points or tables to list information
    • scanned diagrams or other appropriate images as part of the design process
    • other styles of non-extended writing or diagrammatic representation such as flow charts, Gantt charts or spider diagrams where appropriate.

 If the student includes extended writing, the words will be included in the word count and the student will self-penalize if the total number of words in the documentation exceeds 2,000.

  • The Record of tasks form in the zip file must be used. A series of documents that use text (extended writing) that:
    • describes the scenario, client requirements and/or adviser input
    • justifies the rationale behind the proposed product
    • explains the techniques used to develop the product
    • evaluates the success of the product in resolving the original problem and client and/or adviser feedback recommends further improvements to the product.

This should be the only information that is included in the word count and it must not exceed 2,000 words.

It is recommended that the blank files in the zip file are used for the documentation.

  • Appendix/appendices that show, if appropriate, any additional information such as:
    • evidence of consultation with the client/adviser
    • evidence of feedback from the client/adviser
    • additional videos or documents containing screenshots of the product functioning.

References[edit]