When is documentation considered continuous?
We Consider Documentation Continuous If It Meets The Following Criteria:
- Written When Best
This means documentation that explicitly references parts of the code.
For example, including code snippets, names of functions or variables, file paths and other explicit reference to the code, within the documents.
Continuously verifying documentation means making sure that the current state of the documentation matches the current state of the codebase, as the code evolves.
Continuously creating documentation means that documentation is written not as an aftermath, but when it makes sense.
The best way to achieve this is by running Swimm's verification checks within your existing continuous integration workflow, or building a continuous integration workflow with Swimm if you don't currently use a CI server. If you can't adopt a CI server, it can be accomplished through commit hooks.