Name
Abstract | ||
|---|---|---|
Successful software systems need to be maintained. In order to do that, deep knowledge about their architecture and implementation details is required. This knowledge is often kept implicit (inside the heads of the experts) and sometimes made explicit in documentation. The problem is that systems often lack up-to-date documentation and that system experts are frequently unavailable (as they got another job or retired). Redocumentation addresses that problem by recovering knowledge about the system and making it explicit in documentation. Automating the redocumentation process can limit the tedious and error-prone manual effort, but it is no 'silver bullet'. In this paper, we report on our experience with applying redocumentation techniques in industry. We provide insights on what (not) to document, what (not) to automate and how to automate it. A concrete lesson learned during this study is that the "less is more" principle also applies to redocumentation. |
Year | DOI | Venue |
|---|---|---|
2010 | 10.1145/1862372.1862382 | EVOL/IWPSE |
Keywords | Field | DocType |
redocumentation address,redocumentation process,concrete lesson,legacy banking system,system expert,redocumentation technique,successful software system,error-prone manual effort,up-to-date documentation,experience report,implementation detail,deep knowledge,software systems,software evolution | Silver bullet,Architecture,Software engineering,Systems engineering,Computer science,Software system,Software evolution,Program comprehension,Documentation,Deep knowledge | Conference |
Citations | PageRank | References |
3 | 0.41 | 11 |
Authors | ||
3 | ||
Name | Order | Citations | PageRank |
|---|---|---|---|
| Joris Van Geet | 1 | 26 | 2.27 |
| Peter Ebraert | 2 | 153 | 10.53 |
| Serge Demeyer | 3 | 2250 | 291.74 |