Blog

On a number of occasions I’ve been asked to suggest a productivity metric for technical writers, usually as part of a performance management initiative.

Triggering a build of an Antora site when changes are merged into the main branch ensures that builds occur regularly but not excessively frequently, and that they are only triggered by a trusted user (a repo owner).

A common approach to updating a doc site is to build the site on a regular automated schedule, for example, daily at midnight.

As with Hugo, it is possible to configure an Antora project to be built on Netlify. This means that Netlify monitors a designated Git repository (on a provider such as GitHub or GitLab) for changes to a specified build (for example, main) and automatically runs a build whenever changes are detected.

AsciiDoctor-Diagram is an extension of Asciidoctor that enables you to create diagrams using plaintext directly in your AsciiDoc files. Asciidoctor-Diagram supports a number of formats, including:

It can be daunting to put together a toolset to create and deliver online documentation. I know because I spent a number of months in 2021 investigating options and proposing a toolset for a software company to which I was consulting.