VI.10 Quality Requirements

QS1: Confidentiality

In order to keep control over the content of your documentation, docToolchain will never use a web-based, remote service for any task without the explicit knowledge of the user.

QS2: Security (besides Confidentiality)

When you think of documentation, security is not the first thing that comes to mind, is it?

However, when you automate some parts of your documentation, or even just include remote sources, security comes into play.

It could even be that you use a plugin (such as the asciidoctorj-screenshot plugin, which is available at https://github.com/asciidoctor/asciidoctorj-screenshot) that lets you execute arbitrary code in the generation phase.

In docToolchain, we assume that the documentation is under your control, and hence, do not apply any special security measures besides respecting QS1: Confidentiality.

QS3: Repeatability

Every run of a docToolchain task creates the same predictable output.

This rule ensures that it doesn't matter if...