Writing docs

(253)

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

Interviewing Subject Matter Experts for your documentation

10/23/2018 - Catherine Heath

Even seasoned technical writers, with decades of domain-specific experience and in-depth technical knowledge, will find themselves interviewing SMEs. And yet many find this part of their role quite tricky.

The Not-Boring Tech Writer podcast review – Surviving in the Dev World

Writing docs

10/11/2018 - Catherine Heath

Jacob’s latest podcast guests are Michal Skowron and Pawel Kowaluk. They are both technical writers at Guidewire Software and they’re based in Kraków, Poland.

Don’t say “simply” in your documentation by Jim Fisher

Writing docs

9/26/2018 - Catherine Heath

Jim Fisher is a technical product manager at Pusher, and he gave a great talk at Write the Docs Prague 2018 about the drawbacks of using the word “simply” in your documentation.

Learning to love release notes by Anne Edwards

Writing docs

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.