1. 1 Maintenance of Documentation and Documentation of Maintenance Quiz 7 Tori Bowman CSSE 375, Rose-Hulman October 1, 2006

2. State of 375 HW 4 due 11:55 pm tonight Oct. 8th HW 4 due 11:55 pm tonight Oct. 8th Test Review tomorrow Test Review tomorrow –Test 1: October 3 rd from 7pm-9pm Thursday: Final maintenance report; transition Thursday: Final maintenance report; transition 2

3. 3 References Chapter 11 of SW Maintenance Chapter 11 of SW Maintenance Chapter 32 of Code Complete Chapter 32 of Code Complete

4. 4 Outline Maintenance of Documentation Maintenance of Documentation Documentation of Maintenance Documentation of Maintenance

5. 5 Maintenance of Documentation

6. 6 Technical vs. User Documentation Technical documentation involves artifacts used by software developers and maintainers Technical documentation involves artifacts used by software developers and maintainers Examples Examples –Design Document –Quality Assurance Data (through metrics) –Maintenance Requests –Most of this lecture: code documentation User Documentation will be discussed in later classes User Documentation will be discussed in later classes

7. 7 What does this even do?!

8. 8 …self-documenting code

9. Kinds comments Repeat of the code Repeat of the code –Gives the reader more to read w/o being value-added Explanation of the code Explanation of the code –If the code is so complicated that it needs to be explained – rewrite it Marker in the code Marker in the code –To-do, ********NOT DONE Summary of the code Summary of the code –Especially helpful in maintenance Description of code’s intent Description of code’s intent Information that can’t be expressed in code Information that can’t be expressed in code 9

10. Tips for commenting efficiently Use styles that don’t break down or discourage modification Use styles that don’t break down or discourage modification –Example on following slides Use pseudo code programming Use pseudo code programming Integrate commenting into your development style Integrate commenting into your development style –Make this apart of your coding standards! Performance is not a good reason to avoid commenting Performance is not a good reason to avoid commenting IBM study: 1 comment for every 10 lines of code IBM study: 1 comment for every 10 lines of code 10

11. Comic of the day…. 11

12. 12

13. 13

14. 14 Don’t comment tricky code; rewrite it!

15. 15 Check out Doxygen: www.doxygen.org/

16. 16 Documentation of Maintenance

17. 17 Some Additional Documentation Needed for Maintenance Some Depend on Maintenance Process Used Some Depend on Maintenance Process Used Example Example –Maintenance Plan –Delta Vision Documents –Requests for Change How to use within process? How to use within process?

18. 2 nd Comic of the Day…. 18

19. 19 Documentation for our Maintenance Projects Maintenance Plan Maintenance Plan Maintenance Project Plan Maintenance Project Plan Software Manual Software Manual Transition Plan Transition Plan

20. QUESTIONS? 20