Writing docs

(237)

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

Hiring junior technical writers who can contribute successfully to your team

5/16/2018 - Catherine Heath

At Write the Docs Portland 2018, Technical Writer at Pivotal Sarah Day gave a talk about how to hire junior documentation writers.

Examples of beautiful docs to inspire your self-service content

Writing docs

4/9/2018 - Catherine Heath

Learn how to make your documentation sparkle by examining how other organizations apply the concepts of beauty to their knowledge bases.

Are you making any of these 4 inclusivity mistakes with your docs?

Writing docs

3/27/2018 - Catherine Heath

Being inclusive means creating a welcome atmosphere in your docs for as many people as possible. Learn if you are making these mistakes.

What the British government can teach us about knowledge base UX

Writing docs

3/15/2018 - Catherine Heath

UX is a specialised field, but anyone can pick up the basic principles and use it to design a better knowledge base, even the British government!

11 documentation writing tips that will save your life (maybe)

Writing docs

2/2/2018 - Catherine Heath

On a limited budget, it’s often about producing more documentation in less time – while still maintaining quality and usefulness. What’s a documentarian to do?

Plain language is the key to documentation that thrills your users

Writing docs

1/25/2018 - Catherine Heath

Plain language has a very tangible benefit for your documentation. It makes your writing much easier to comprehend, and this contributes to the overall goal of your knowledge base.