Project Documentation Generator

The software documentation process is an integral part of the software development process. Software documentation is an organized collection of written material which aids developers in understanding software. During the software development process, software development teams generate different kinds of documentation. Some of this documentation is for internal use, some of it is delivered to you (guarantee that the software complies with certain standards,...) The classical approach to documentation generation is to write the documentation in one of the available text-processors, copying certain items (figures, tables, text, ...) from the development tools, and integrating ("pasting") them into the document. A positive side to this approach is the full control over each part of the document. However, it is easy to conclude that with massive projects this task can be an arduous one (for example, if 1000 functions were to be documented in this way). A second flaw to this approach is that each and every change in the project requires the documentation process to be repeated for the altered part. This flaw has a negative effect on how up-to-date the documentation is. The solution lies in connecting the documentation writing tool and the software development tools while at the same time ensuring that the documentation be kept up-to-date automatically.

The solution offered by DAC is the automation of the software documentation process. The DAC component which automates this process is the Documentation Generator (DG). As an integral part of DAC, DG uses all its capabilities to automate the documentation generation process and to ensure high-quality documentation.

Here are the DG goals:

- To automate the software documentation generation process on the basis of various kinds of reports formed by DAC.
- To achieve the consistency of software and corresponding documentation, that is to produce up-to-date software documentation.
- To achieve facility of use.
- To realize as many present and future DAC potentials as possible.
- To adapt the form of the reports to your needs and documentation standards.
- To ensure that the same part of the documentation template can be repeated for different objects which are being documented which greatly reduces the time needed to generate documentation for massive projects.

Numerous groups of participants in the software production process will find DG highly useful:

- Coordinators - project-managers for the analysis of work results,
- Software developers and programmers who use DAC to develop software,
- Sector/company quality control teams,
- Software developers and programmers who use the reverse engineering method to obtain models or document existing systems, and
- Teams in charge of writing user and reference manuals.


Copyright 1993-2017, RistanCASE GmbH