Efficient Authoring of Software Documentation Using RaPiD7

1
Efficient Authoring of Software Documentation
Using RaPiD7

• Roope Kylmakoski, Nokia
• 25th ICSE (03)
• p. 255
• Poster by Matthew Choi

2
Summary

• RaPiD7 is a method developed for an efficient
  document authoring in software development
  projects
• Promotes team involvement and commitment
• Documentation using this method
  leads to a more effective
  software inspection
• Designed to be scalable

3
Background

• RaPiD7 (Rapid Production of Documentation, 7
  steps) developed in Nokia during 1999 - 2000
• Aimed to improve traditional approach for
  document authoring
• Spent excessive amount of time
  (especially for modifications)
• Recurring defects in documentation
• Contents mostly based on opinion
  of the writer (lack of objectivity)

4
RaPiD7 Need for such method

• General goal of Documentation
• Sharing information
• Keeping track of information shared
• Gaining understanding
• Challenges of Documentation
• Never done right the first time
• Poor documentation causes delays
  during the inspection process
• No proper commitment by the author
• Inadequate level of understanding for
  the reader

5
RaPiD7 How it works

• Done before (or in place of) Software inspection
• Qualified team is trained and formed
• Document is basically authored by the team during
  a series of workshops
• Workshop involves 7 steps
• Some steps may be omitted
• Number of workshops should be determined
  based on the size of the project
• Entire process typically takes about
  one week in calendar time

6
RaPiD7 - Process

• Creating a document using RaPiD7

7
RaPiD7 Analysis Benefits

• Artifacts and specifications will be produced in
  a relatively short time
• Inspection of document typically will not be
  needed
• Reduce documentation re-work
• Gets all parties involved and committed
• Reduce or eliminate software inspection time
• Overall quality improvement

8
Critique

• Strengths
• Provided good case for why the method was created
• Good description of how the method works
• Weaknesses
• Did not provide concrete example of
  how the method was used
• Lack of benefit analysis to support the
  savings

9
Questions

• What are the steps involved in RaPiD7 workshops?
• How many workshops are required?
• In any given project, there will be
  artifacts or tasks that will not need
  such formal documentation method.
  At the same, there are tasks such as requirement
  analysis that will benefit from such
  method. What are some others you can
  think of?