Automation
1 min
By automating your processes, you can ensure consistency in your documentation, while at the same time reducing manual effort.
Automation can be:
- Ad hoc - quick, one-off solutions
- Systematic - repeatable processes integrated into a pipeline, with consistent triggers
This list provides some examples of ad hod and systematic automation scenarios:
- Create a Jenkins job that gets the latest documentation changes from source control, then builds and publishes the online help to a staging area.
- Automatically identify and insert internal links between related sections of documentation.
- Use search & replace in a text editor to change file paths as a result of a migration to a different tool.
- Set up automated alerts or notifications to inform stakeholders when documentation has been updated or requires review.
- Send drafts for review to appropriate stakeholders automatically, then track their approval or feedback.
- Set up a pre-commit hook in a Git repository that prevents you from committing files if you used inline formatting instead of HTML classes.
Have a question?
Our super-smart AI, knowledgeable support team and an awesome community will get you an answer in a flash.
To ask a question or participate in discussions, you'll need to authenticate first.