7.5

Topic 7

Documentation

  • IGCSE I.C.T 0417
  • 1 min read
  • Syllabus 2026, 2027 and 2028

Objectives

  1. 1

    Documentation

    • aCharacteristics, uses and purpose of technical and user documentation
    • bComponents of technical documentation including: purpose of the system/program, limitations of the system, program listing, program language, program flowcharts/algorithms, system flowcharts, hardware and software requirements, file structures, list of variables, input format, output format, sample runs/test runs, validation routines
    • cComponents of user documentation including: purpose of the system, limitations of the system, hardware and software requirements, how to load/ run/install software, how to save a file, how to print data, how to add records, how to delete/edit records, input format, output format, sample runs, error messages, error handling, troubleshooting guide/helpline, frequently asked questions, glossary of terms

Cambridge IGCSE ICT 0417 syllabus 2026-2028, 7.5 Documentation (copied for internal use as permitted by Cambridge)

Detailed · Deep study

1Technical documentation

Technical documentation is written for the programmers and analysts who will maintain, repair or upgrade the system later.

  • purpose of the system/program; limitations of the system
  • program listing; program language; program flowcharts/algorithms; system flowcharts
  • hardware and software requirements
  • file structures; list of variables; input format; output format
  • sample runs/test runs; validation routines

2User documentation

User documentation (a user guide or manual, often online) helps users to use the system and solve problems.

  • purpose of the system; limitations of the system; hardware and software requirements
  • how to load/run/install the software; how to save a file; how to print data
  • how to add records; how to delete/edit records
  • input format; output format; sample runs
  • error messages; error handling; troubleshooting guide/helpline
  • frequently asked questions; glossary of terms

3Exam focus

Key words: technical documentation; user documentation; program listing; list of variables; troubleshooting guide; FAQ; glossary.

Quick self-check

Answer in your head first, then reveal.

  1. To help programmers/analysts maintain or upgrade the system (1).

  2. Any three: program listing; program language; flowcharts/algorithms; list of variables; file structures; validation routines (3).

  3. Any three, e.g. how to install; how to save; how to print; error messages; troubleshooting guide; FAQs; glossary (3).

Finished this subtopic? Track it on your subject page.