1. WARNING These slides are not optimized for printing or exam preparation. These are for lecture delivery only. These slides are made for PowerPoint 2010. 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.

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

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

9. Developer-to-developer docs

11. for developer as user for developer as maintainer

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

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

15. Do Don’t Do Don’t Do Don’t Do Don’t

17. Just enough docs As much docs as possible

18. Top-down Bottom up

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

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

27. Docs from code White elephants

28. Comprehensible Comprehensive Use cases Class diagrams Sequence diagrams

29. Remember the purpose

30. So, how many class diagrams to include?

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

32. 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 0 77577 OR tinyurl.com/answerpost RT?M ST?W GIYF LMGTFY