Maintenance of Documentation and Documentation of Maintenance Quiz

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

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

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

Outline • Maintenance of Documentation • Documentation of Maintenance 4

Maintenance of Documentation 5

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

What does this even do? ! 7

…self-documenting code 8

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

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

Comic of the day…. 11

12

13

Don’t comment tricky code; rewrite it! 14

Check out Doxygen: www. doxygen. org/ 15

Documentation of Maintenance 16

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

2 nd Comic of the Day…. 18

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

QUESTIONS? 20