Technical Documentation
- Characteristics: Detailed information on the system's inner workings and programming for developers and IT staff
- Uses & Purpose: To maintain, repair, and update the system with improvements
- Components:
- 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
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]
3 of:
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]
