What documentation does a system need, and who uses each type?
The purpose and contents of technical documentation and user documentation, and the audience each serves during development, use and maintenance.
A CCEA A-Level Digital Technology answer on system documentation: the purpose, contents and audience of technical documentation and user documentation, and why each matters during development, use and maintenance.
Reviewed by: AI editorial process; not yet individually human-reviewed
Have a quick question? Jump to the Q&A page
Jump to a section
What this dot point is asking
CCEA wants you to distinguish technical documentation from user documentation, to describe what each contains, and to identify who uses each and why. Documentation is produced across the life cycle and is the reason a system can be operated, maintained and audited long after the original team has moved on.
Two audiences, two documents
The split exists because the two audiences need completely different information. A maintainer needs the data dictionary and commented code; an end user needs to know which button reserves a book and what to do when an error appears. Mixing the two helps neither.
Technical documentation
Because maintenance is usually done later and often by different people, technical documentation is what prevents a maintainer from having to reverse-engineer the system from scratch. It also supports auditing and quality assurance, since the design and test evidence are recorded.
User documentation
User documentation is written in plain language for non-technical users. It typically contains installation instructions, how to start the system, step-by-step guidance for each function (often screen by screen), a troubleshooting or frequently asked questions section, and explanations of error messages and how to resolve them. Good user documentation reduces support calls and helps users become productive quickly, which supports the operational acceptance of the system.
Why documentation is examined
Documentation is the thread that ties the whole life cycle together: each stage produces a deliverable, and those deliverables become the technical and user documentation. CCEA examines it because a system without documentation is hard to use, expensive to maintain, and impossible to audit, regardless of how good the code is.
Try this
Q1. State who the main audience of technical documentation is. [1 mark]
- Cue. Developers and maintenance staff (programmers who maintain the system).
Q2. List three items found in user documentation. [3 marks]
- Cue. Installation instructions; how to use each function; troubleshooting or frequently asked questions; explanations of error messages (any three).
Q3. Explain why the test plan is kept in technical rather than user documentation. [2 marks]
- Cue. The test plan is needed by maintainers to retest the system after changes; end users do not run tests, so it serves the technical audience.
Exam-style practice questions
Practice questions written in the style of CCEA exam questions on this dot point, with worked answer explainers. The year tag is the paper they imitate, not the source.
CCEA AS 16 marksDistinguish between technical documentation and user documentation, and describe the typical contents of each.Show worked answer →
Define the audience of each, then list typical contents.
Technical documentation is written for developers and maintenance staff. It typically contains the system design (data flow diagrams, flowcharts, entity relationship diagrams), the data dictionary, program code with comments, algorithms, the test plan and results, and details of the hardware and software environment. Its purpose is to let a programmer who did not write the system understand and maintain it.
User documentation is written for the people who operate the system. It typically contains installation instructions, how to start and use each function, screen-by-screen guidance, a troubleshooting or frequently asked questions section, and error message explanations. Its purpose is to let a non-technical user operate the system without help.
Markers award marks for the correct audience of each, and for valid contents matched to that audience. Putting program code in user documentation, or installation-for-end-users content in the technical manual, loses the matching marks.
CCEA AS 14 marksExplain why good technical documentation is important for the maintenance of a system.Show worked answer →
Link the contents of technical documentation to the maintenance task.
Maintenance is often carried out by staff who did not build the original system, sometimes years later. Without documentation they would have to reverse-engineer the design and code, which is slow and error-prone. Technical documentation, including the design diagrams, data dictionary, commented code and test plan, lets a maintainer quickly understand how the system works, locate the part to change, make the change correctly, and retest using the existing test plan.
Markers reward the points that maintainers may be different people working much later, that documentation saves time and reduces errors, and that the test plan supports safe retesting after a change. A general "it is useful" answer with no link to maintenance limits the marks.
Related dot points
- The stages of the systems development life cycle, the activities carried out in each stage and the documented outputs each stage hands on to the next.
A CCEA A-Level Digital Technology answer on the systems development life cycle: its stages from feasibility through analysis, design, implementation, testing and maintenance, the activities in each, and the documents each stage produces.
- Designing the inputs, outputs, processing, data storage and user interface of a system, and the design tools used: data flow diagrams, system flowcharts, entity relationship diagrams and the data dictionary.
A CCEA A-Level Digital Technology answer on the design stage: specifying inputs, outputs, processing, data storage and the user interface, and the design tools used including data flow diagrams, system flowcharts, entity relationship diagrams and the data dictionary.
- Implementation and installation of a system, the changeover methods (direct, parallel, phased and pilot), their advantages, disadvantages and suitability, and data conversion and user training.
A CCEA A-Level Digital Technology answer on implementing and installing a system: the direct, parallel, phased and pilot changeover methods, their advantages, disadvantages and suitability, and data conversion and user training.
- Levels of testing (unit, integration, system and acceptance), the purpose of a test plan, and the use of normal, boundary and erroneous test data.
A CCEA A-Level Digital Technology answer on testing: the levels of testing (unit, integration, system and acceptance), the purpose of a test plan, and the use of normal, boundary and erroneous test data with expected results.
- The purpose of system maintenance and the three types of maintenance (corrective, adaptive and perfective), with examples of each.
A CCEA A-Level Digital Technology answer on system maintenance: why systems are maintained after delivery and the three types of maintenance, corrective, adaptive and perfective, with examples of each.
Sources & how we know this
- CCEA GCE Digital Technology specification — CCEA (2016)