5. Documentation

Students Learn About:

Documentation

•       types of documentation

–      documentation for developers

–      documentation for users

•       internal documentation

–      meaningful variable names (intrinsic)

–      readability of code

-        comments

-        white space

-        indentation

•       online help, such as:

–      context sensitive help

–      help files


Students Learn To:
  • produce documentation for different audiences
  • produce source code which is well documented and therefore easy to read, understand and maintain
  • fully document a solution that has been developed in the classroom
  • create a data dictionary to define the data (including variables, arrays and records) used in a developed solution
  • use a range of application packages to develop the various types of documentation to fully document a solution
  • interpret code and documentation prepared by others
  • assess the effectiveness of online help available in software packages




5 Documentation










Subpages (1): Student Activity
Comments