WARNING These slides are not optimized for printing or exam preparation. These are for lecture delivery only. These slides are made for PowerPoint They may not show up well on other PowerPoint versions. You can download PowerPoint 2010 viewer from here.here These slides contain a lot of animations. For optimal results, watch in slideshow mode.

The M in RT?M : When Code is not Enough

Developer-to-developer docs The M in RTFM : When Code is not Enough

Developer-to-developer docs

for developer as user for developer as maintainer

Developer-to-developer docs for developer as user for developer as maintainer

Developer-to-developer docs for developer as user for developer as maintainer

Do Don’t Do Don’t Do Don’t Do Don’t

Just enough docs As much docs as possible

Top-down Bottom up

300,000+ LoC (Lines of Code) 700+ source files 1 week to start coding

Docs from code White elephants Java: Javadoc C++: DoxyGen

Docs from code White elephants

Comprehensible Comprehensive Use cases Class diagrams Sequence diagrams

Remember the purpose

So, how many class diagrams to include?

Comprehensible Comprehensive Docs from code White elephants Top-down Bottom up Just enough docs As much docs as possible Remember the purpose

How many of the following do you know? know {0|1|2|3|4} e.g. know 0 know {0|1|2|3|4} e.g. know OR tinyurl.com/answerpost RT?M ST?W GIYF LMGTFY