Guide to non-exam assessment documentation common mistakes

Common mistakes

• Using vague objectives

  Writing objectives such as "make the system effective" or "create a good solution" without stating a specific, measurable outcome.

  Fix itRewrite each objective so that it has one purpose, describes an observable outcome and provides enough detail for its scope to be interpreted without ambiguity.

• Listing technologies without explaining their role

  A student names a database, library, or framework but does not explain how the solution will rely on it.

  Fix itState the relevant dependency and describe its place in the proposed structure or operation of the solution.

• Confusing many comments with self-documenting code

  Assuming that adding comments to every line automatically makes a program listing self-documenting.

  Fix itUse meaningful identifiers and well-structured code first, then add explanations where sections are particularly difficult to understand.

• Recording every possible test

  Including a very large list of tests and outcomes without selecting the most useful evidence.

  Fix itChoose a balanced and representative sample that demonstrates the requirements and robustness of the complete or nearly complete solution.

• Listing feedback without evaluating it

  Including comments from feedback but not explaining how or why they were taken into account.

  Fix itDiscuss what the feedback shows about meeting the requirements and explain how and why it influenced the outcome.