VI.11 Risks and Technical Debts
This section describes the risks that might be posed by using docToolchain and how they are—from an architectural point of view—mitigated.
TR1: Outdated Technology
Description: A software system might live for several decades. During that time, some parts of the toolchain might get outdated. For instance, a UML modeler you didn't buy a new license for.
In such cases, you might not be able to regenerate parts of your documentation.
Mitigation: The biggest risk of this kind is related to the proprietary tools the diagrams and texts are exported from. docToolchain exports these artifacts, not to the /build folder, but to the /src/docs folder on purpose:
- If one of the tools gets outdated, you still have the exported data, and therefore, you can still work with it.
- In addition, exported .png images and plain text files are easier to compare than binary source formats, which come often. This enables you to better review the changes in your...
