Blog

A big bunch of balloons in shades of blue and white

Technical Writing Courses Coming Soon!

I’m developing two technical writing courses. The beginner course will help new people to gain the skills needed for the software industry. The Agile course will help existing technical writers to function and thrive in teams using Scrum, Lean, Kanban, and other Agile methodologies.

A close up of many old, random metal letters with copy space

Creating Manuals Using RST and Sphinx: Text Formatting

ReStructuredText is one of the more persnickety documentation ‘languages’ out there. Blank lines and spaces can often be the difference between a lovely end document and absolute chaos. In this post, I’m going through the basic text formatting options that you’ll need to create a clear, readable document.

A woman dressed in leggings, crop top, and boxing gloves performs a high kick

5 Signs That Your Doco is Kick-Arse

I’ve talked a lot about how to improve your documentation. But what if your doco doesn’t need changing? How do you know when your doco is already awesome? Here are five signs to look for.

A classic comic-style 'pow' background with the word 'KAIZEN!' superimposed

ITIL 4 and Technical Writing: Continual Improvement

This is the first article in a series about using ITIL 4 concepts in developing documentation strategy. These articles are for technical writers, documentation strategists, and product managers who want to improve documentation.

Technical Writing and Cloud Technology

Cloud technology is huge in the technology world right now. Most experts predict that it’s only going to increase in market share. In this article, I’ll look at cloud technology from the perspective of technical writers and what technical writers need to know in order to work in and with the cloud.

Creating Manuals Using RST and Sphinx: Child Documents

Child documents, or sub-documents, make up the bulk of a project. Think of them as Lego blocks – pieces of various sizes that can be put together to make all sorts of end documents. Each child document answers a single question, or addresses a single topic.

How to Develop Agile Documentation

Traditional software documents are created from the top down. Figure out who will be doing what with the software, then write documents aimed at each category of users, explaining how to use every bit of functionality they should (theoretically) need to use. This method really doesn’t fit in well with modern software design. So how can we use basic concepts from Agile methodology to develop Agile documentation?

How to Create a Documentation Strategy

Your documentation is one of the first things people look at when they’re having trouble using your product – or thinking of using your product. As such, it’s a powerful ambassador for your company.

So let’s look at some of the aspects of documentation strategy that you need to consider.

5 Types of User Feedback to Collect

Users leave us a lot of feedback these days. Some of it is active and deliberate, like adding a comment to an article on a website. Some of it is incidental, like clicking on an article and then closing the browser window before the page has fully loaded. And many companies aren’t taking advantage of all of the user feedback they could be collecting.