Lecture overview -- Keyboard shortcut: 'u'  Previous page: Which kind of documentation -- Keyboard shortcut: 'p'  Next page: Integrated program documentation -- Keyboard shortcut: 'n'  Lecture notes - all slides and notes together  slide -- Keyboard shortcut: 't'  Help page about these notes  Alphabetic index  Course home  Page 9 : 47
Elucidative Programming
Views on documentation

There are many different views on documentation, including common attitutes that are reconfired among programmers to such a degree, that most of us belive they are true.

Many programmers are reluctant to read and write program documentation

  • Documentation of program understanding (DOPU)

    • Programming requires understanding of both the problem and its solution

    • We cannot afford to forget the understanding once established

    • It is expensive to reestablish the understanding if its forgotten.

We see documentation as an investment in more high quality programs

We hypothesize that the investment is payed back during the life time of the program

We call for a professional attitude towards this problem