Writing docs

Learn 8 best practices to ensure your knowledge base articles are consistent and easy to understand.

From MailChimp to Airbnb, there are a number of companies that have struck gold with their knowledge bases. We share four examples with you.

As the famous Stephen King said of writing, you should “kill your darlings”. This means we need to let go of things that we feel emotionally attached to but are no longer serving us, which is a big part of the KonMari approach. This idea applies to our documentation as much as anything else.

Data governance defines who (within a company) can use and manage data. Tech writers will be increasingly involved in this work, and affected by data management.

This article suggests tha technical writers should also be UX advocated. It looks at what UX is, and how UX concerns overlap with tech writing.

Your company brand can be represented in everything you publish, including sections of your docs such as release notes.