The Systems Life Cycle: Documentation (Cambridge International IGCSE ICT)
Exam board Cambridge International · IGCSEUpdated 2024-05-13
Technical Documentation
Spec point —
7.5.1
What is technical documentation?
-
Technical documentation is detailed information on the system's inner workings and programming for developers and IT staff
-
Technical documentation enables the system to be:
- Maintained
- Repaired
- Updated
| Technical documentation includes: | |
|---|---|
| Purpose of the system/program | Explanation of the system's intended function and goals |
| Limitations | Known constraints or issues with the system |
| Program listing | The code or scripts used in the system |
| Program language | The programming language used to develop the system |
| Program flowcharts/algorithms | Visual representations or descriptions of the system's logic and processes |
| System flowcharts | Visual representations of the interactions between system components |
| Hardware & software requirements | Necessary equipment and software to run the system |
| File structures | Organisation and layout of the system's files and data |
| List of variables | Collection of variables used within the system, including their names and purposes |
| Input format | Structure and format for entering data into the system |
| Output format | Structure and format for presenting data generated by the system |
| Sample runs/test runs | Examples of system operation, including input and expected output |
| Validation routines | Techniques used to check and confirm the accuracy of data entered into the system |
User Documentation
Spec point —
7.5.1
What is user documentation?
- User documentation is instructions and guidance for end-users on how to operate the system
- User documentation enables end-users to effectively use the system and overcome problems
| User documentation includes: | |
|---|---|
| Purpose of the system | Explanation of the system's intended function and goals |
| Limitations | Known constraints or issues with the system |
| Hardware & software requirements | Necessary equipment and software to run the system |
| Loading/running/installing software | Instructions for setting up the system on user devices |
| Saving files | Procedures for storing data within the system |
| Printing data | Steps to produce hard copies of system data |
| Adding records | Instructions for creating new entries in the system |
| Deleting/editing records | Guidelines for modifying or removing existing entries in the system |
| Input format | Structure and format for entering data into the system |
| Output format | Structure and format for presenting data generated by the system |
| Sample runs | Examples of system operation, including input and expected output |
| Error messages | Explanations of system warnings and error notifications |
| Error handling | Steps to resolve issues and errors within the system |
| Troubleshooting guide/helpline | Assistance for diagnosing and addressing common problems |
| Frequently asked questions | Answers to common user inquiries |
| Glossary of terms | Definitions of key terms and concepts related to the system |
Worked Example Following the implementation of the system, technical documentation needs to be written.
Identify three components of technical documentation which are not found in the user documentation.
[3]
Answers
three of:
Final answer: program listing [1] program language [1] program flowcharts/algorithms [1] system flowcharts [1] file structures [1] list of variables [1] test runs [1] validation routines [1]
Was this revision note helpful?
Build on this topic