ProgrammingSequence, selection, iteration, procedures, functions, modules, parameters, compilers, interpreters

Syllabus Detail

  • Internal External 11 ATAR, 12 GEN, 12 ATAR

Background

  • Documentation is a set of documents that provide information on a program
  • A program will often consist of internal and external documentation
  • Both provide developers and end-users alike with instructions and information on the program

 

Internal Documentation

  • Internal documentation is documentation written within a program
  • This refers to any comments and instructions written by and for the developer(s)
  • Internal documentation is used to keep a form of communication open between developer(s)
  • It's used to explain parts of code as well as provide useful information on the program internally
  • This form of documentation can be written as comments or manuals

 

External Documentation

  • External documentation refers to manuals and guides written for end users
  • These documents explain how to operate a program and use it for its intended use
  • External documents are common with all types of software and hardware
  • These documents are written by developers and other end-users
  • Unlike internal documentation, these notes don't explain how functions work, but rather how to use them

 

Further Research

  • Read Lamar University's Guidelines for Programming Documentation here
  • Read Technology Evaluation Center's article on Difference between Internal and External Documentation here

 

Worksheet and Practice (yet to be added)

Found an error or have an enhancement? Please let us know via this contact form