Writing docs

(237)

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

What is a knowledge base? Don't get caught out at dinner parties.

8/22/2016 - Catherine Heath

We wrote this article to help you avoid any embarrassment at dinner parties in case the topic of knowledge bases came up. But seriously, how do you describe it to the layman?

Just-in-time documentation: Employing agile methodology in documentation

Writing docs

8/17/2016 - Bri Hillmer

Just-in-time documentation helps you focus on 1) what users are actually trying to accomplish that 2) they cannot figure out on their own.

Your knowledge base as a marketing tool

Writing docs

3/6/2015 - Marybeth Alexander

While its primary function may be to share information with current customers, your knowledge base can also be helpful to prospective customers.

Letting customers know there’s someone behind the documentation curtain

Writing docs Support

6/27/2014 - Bri Hillmer

The importance of letting customers know there is a real person behind your documentation, and how to do it.

How to restrict access to online documentation

Writing docs

6/10/2014 - Marybeth Alexander

In order to ensure that your online content is only available to certain individuals or groups, you can utilize a variety of security features to make sure your information is only available to that audience.