[prev] [index] [next]

Documentation

Large systems involve various kinds of documentation:
  • user manuals, API definitions, language references, ...
Keeping documentation consistent with code is critical
  • literate programming: a document with embedded code
  • documentation generators: code + embedded documentation
Indepdent generation of code and documentation
  • needed where doc not directly related to code (e.g. tutorials)
  • document processors ok for this (e.g. LaTeX, DocBook, Wiki)