---
title: Automation
slug: books/technical-writing/automation
createdAt: 2025-04-29T17:04:01.617Z
---

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&#x20;**- repeatable processes integrated into a pipeline, with consistent triggers

![](https://api.archbee.com/api/optimize/fh9Kla9lm_P4ujQJfZyJC/7eTXs677uBat4uaihp_Zo_image.png)

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.&#x20;
- **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.

