Computer aided documentation for software maintenance

摘要

Upon inspection much of the documentation that exists for software applications is either associated with its design or its user interface i.e. reference manuals and user guides. Little, if any documentation, is specifically produced to help those who are involved with looking after the application once it is released to its users, and enters its maintenance phase. If such documentation does exist it is often found not to accurately represent the current state of the application. As a solution, the author suggests the use of code documentation tools. These tools can provide those involved with looking after existing applications with virtual information, and the mechanism for keeping notes about them. In the same way that a carpenter or a plumber needs the right tools to complete their jobs, those working in maintaining software need tools to help them perform their tasks in an effective manner. Code documentation tools are now available which can not only aid the extraction and analysis of existing applications, but provide accurate information in a form that is easy to understand, interactive in use, and most importantly is shareable by all those needed to work on the project.