Writing docs

(244)

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

Brainstorming our documentation strategy at Write the Docs Prague

11/15/2018 - Catherine Heath

We brainstormed our new documentation strategy on Writing Day, and we wanted to share the full extent of what we learned during that session.

Putting users first with knowledge base UX

Writing docs

11/8/2018 - Catherine Heath

User Experience is naturally geared towards helping your users accomplish their goals as they relate to your product and company, and so is your knowledge base.

How knowledge bases fit into Knowledge Management software

Writing docs

10/29/2018 - Catherine Heath

We thought it was time to explain exactly what Knowledge Management is, how it can benefit your business, and if you need a knowledge base for your company.

Interviewing Subject Matter Experts for your documentation

Writing docs

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.