Use-Oriented Documentation in Software Development
Erik Berglund · 1999
Software documentation is an important tool in modern component-based programming. Building software applications requires detailed knowledge about a vast number of components and the structures they form. This knowledge is often acquired by reading reference documentation of application-programming interfaces (APIs). Thus, the design of the API reference documentation and its reading support affect the cost and quality of software development. We examine how efficiency and quality in software development can be increased through the design of software documentation and reading support for software documentation. The thesis reports on the DJavadoc project and the reading support for online Java API reference documentation that it provides. The Java API reference documentation can be viewed as a collection of documentation designed for multiple needs. As a consequence, excessive information is present in most situations. In DJavadoc we have extended the official Java API reference documentation to achieve control over the visibility of information types. DJavadoc adds client-side, real-time redesign to the documentation to support the design of multiple views. As a result, the reader may further design views of the information that are more in