Automation allows us to provide more functionality at a lower maintenance cost, as well as enable and support community contributors.
When to use it
When thinking about what to automate in your documentation, look for tasks that are frequent, repetitive, or tedious.
Often, the easiest way to do that is to think through the following questions:
- What do new team members or infrequent contributors struggle with?
- What is part of your standard review checklist? And which steps require an additional level of attention to detail?
- What do stakeholders commonly misunderstand? What do they strugle with?
Another component to think about is how often this automation runs:
- What checks need to run on every contribution? Or, another way, what issues would cause you to decline a contribution?
- What checks take a lot of time to run?
- If a check found something wrong, what would be the expected turnaround for a fix?