Automation

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