Technical Writing Articles and Tutorials


How to Include Remote Sources in AsciiDoc
April 9, 2020

How to Include Remote Sources in AsciiDoc

AsciiDoc can include code from remote sources, not just local files. In this post, I’m going to show you both how to do it, as well as how doing so can make your content extremely flexible and much less intensive to maintain.

Antora 101: How to Create Redirects
April 30, 2019

Antora 101: How to Create Redirects

Whenever you create online documentation, eventually, the structure needs to change; such as a name change, content restructure, or old content is removed. When these times come, it’s important to create redirects to avoid breaking user expectations. In this post, I’m going to step you through how to do so with Antora.

April 9, 2019

How to Convert Markdown to AsciiDoc Using Pandoc

Markdown is one of the most ubiquitous file formats around at the moment for writing technical documentation — and it’s easy to see why! However, it may not be the choice long-term. When it’s time to change, you need to be able to migrate to a more feature-rich format. Come learn about the best tool for the job and how to use it.

April 29, 2019

Easily Find Broken Links With Broken Link Checker

When you’re reviewing generated HTML content, broken link’s are the last thing you want. However, given the massive amount of documentation in modern projects, manually hunting for broken links isn’t practical. So how do you deal with this problem?

Validate Markdown Files With MarkdownLint
April 21, 2018

Validate Markdown Files With MarkdownLint

How do you know that your Markdown content is valid? You use MarkdownLint! In this post, I step through how to install, configure, and use it, as well as how to use one-time rule overrides.

Automate Repetitive Tasks With Make
April 18, 2018

Automate Repetitive Tasks With Make

Anything to do with software and computers usually ends up getting tricky, time-consuming, and repetitive. As such, if you value your sanity, you’ll want to regularly look for ways to automate these tasks away. One of the best ways to do that, is by using Make - a veteran automation tool.

PHP Day 2017 (Dresden)
April 24, 2017

PHP Day 2017 (Dresden)

As I traveled home from PHP Day 2017 in Dresden, I decided to put my thoughts together about the conference, and share them with you, if you weren’t there to enjoy the day yourself.

An Initial Sphinx-Doc Workflow
April 7, 2017

An Initial Sphinx-Doc Workflow

Do you use Sphinx-Doc and reStructuredText to manage your project’s technical documentation? Do you find that it’s a lot of work to ensure content validates and renders correctly? If so, this post walks through an initial workflow which seeks to make the process easier and more efficient.