Writing docs

(238)

General posts useful to all documentarians about writing documentation, editing and publishing workflows, and more.

Learning to love release notes by Anne Edwards

9/24/2018 - Catherine Heath

Anne is a technical writer at Improbable and she gave a fascinating talk on how to best write release notes, including how they relate to – well – poetry.

Making video documentation by Sarah Ley-Hamilton

Writing docs

9/20/2018 - Catherine Heath

At Write the Docs Prague 2018, Sarah Ley-Hamilton gave an excellent talk on how to make video documentation for your company.

Web accessibility for your documentation by Carolyn Stransky

Writing docs

9/19/2018 - Catherine Heath

Web accessibility is a well-known issue for web designers, and yet many people still find it difficult to use the internet for a number of reasons. While many software products are accessible already, documentation often gets left by the wayside.

Hire a technical writer for your project in 10 steps

Writing docs

8/31/2018 - Catherine Heath

You’re looking to hire a technical writer and wondering where to start. This post deals with hiring a technical writer for your project in 10 practical steps.

Creating the information architecture for your documentation

Writing docs

8/16/2018 - Catherine Heath

Information architecture is distinct from the quality of your documentation writing. There are categories, there is order, and the structure (hopefully) makes sense.