Skip to main content

Getting Started with Agile for Technical Writers

· 5 min read
Ivan Walsh
Technical Writer

How can technical writers use Agile in software development projects?

As this question, and variations of it, have popped up on Reddit and LinkedIn, I thought I'd share a few observations about my experience of working with Agile/Scrum as a tech writer.

One thing to say before we start, is that just became a company says it's Agile, doesn't mean it's applying all of the framework. Rather, they may be selectively picking pieces of it, such as using Daily Stand Ups, but not fully embracing the spirit of Agile development. In many cases, they're probably 'Agilefall' (Agile + Waterfall).

Using Antora to Manage Complex Technical Documentation Websites

· 8 min read
Ivan Walsh
Technical Writer

What's the best tool for managing technical documentation websites?

You've probably seen something like this on LinkedIn or Reddit. And the answer is, as always, 'it depends'.

For example, this site is run on Docusaurus, which is pretty easy to setup and maintain. It also works very nicely with Git and our web hosting provider, so for a relatively simple site, it's fine. I should add that you can Docusaurus is not just for lightweight document sites as it has quite a lot of rich features, themes, and a very active community. So, worth a peek if you're looking to get started.

However, there are a few things it doesn't offer. At least, not out of the box. This leads us to Antora.