We moved to Calgary

My boyfriend and I moved to Calgary from Vancouver for many reasons. Starting over was one of them. When a door opened, who were we to refuse to enter? Of...

How to improve a list

Lists are common in technical writing. One of my duties is to instruct readers on what to do, step-by-step. Writing lists may seem easy, but I’ve seen a lot of...

Designing buttons in a user guide

A member of the Write the Docs Slack community asked for advice on designing buttons in a user guide. Her three options were: Quotes (e.g., Click “OK”) Brackets (e.g., Click...

Using "recommend" in tech docs

In our Write the Docs Slack network, a member asked if we knew of any best practices on using the word “recommend” in technical documents. There are no official best...

My mistakes in writing descriptions

I’m contributing to an open-source project on GitHub called Awesome, a curated list of interesting topics and their resources. Famous open-sourcer Sindre Sorhus wants help in writing descriptions for each...