Exam-style question
Try this first
A student submits a program listing with short, unclear identifiers, no section headings and no information about the executable or data files. The code contains one especially difficult section, but the student provides no explanation. Assess how the submission could be improved to meet the technical solution requirement.
Model answer
What a good answer should say
- The student should replace unclear identifiers with meaningful ones and improve the structure of the code so that it is more self-documenting and fewer comments are necessary.
- The listing should be divided into appropriately labelled sections to make it easier for a third party to navigate.
- The difficult section should be explained carefully because it may not be understandable from the code alone.
- An overview guide should identify relevant executables, data filenames or URLs, database names and pathnames, enabling a third party to run or investigate the solution if desired.
Explanation
Why this works
The improvements address the main aspects of the requirement: self-documenting code, clear navigation, explanations of difficult code and sufficient information for a third party to access or inspect the solution.
Common mistake
No common mistake is linked to this question yet.