Improvement of efficiency by single source publishing
- Several modern documentation formats are produced automatically
- Old projects can be processed too (re-engineering)
- For each customer and for each internal purpose a custom-made documentation
can be arranged
- Documentation sources become re-usable
- With fewer work arise more possibilities of documentation
Advantages
for the developer team
- At each point of a project up-to-date descriptions of the interfaces exist
- The detailedness of the description is configurable (e.g. quick references)
- Ideal communication base for developer team and development management
- Better overview of other code
- Minimum training period from the installation to the creation of a first documentation
Advantages
for the project management
- Clear documentation interfaces can be defined and controlled
- Contribution to the quality management (ISO 9000ff)
- In case of code modifications the documentation is simply compiled again
- Spend never again man month for documentations that become outdated fast!
Documentation compilers - a necessary Technology
- In manual work it is impossible to manage the mass of all structural
components without errors
- In manual work all modern target formats cannot be produced at the same time
- Documentation compilers generate target formats, but knowledge of the
the target format is not necessary.
(Analogy: Programming language compilers
produce assembler code, without you must be familiar with assembler.)
- Documentation compilers constitute a necessary technology, which will become
generally accepted
|