Writing docs

(241)

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

Get our docs in a row, part 2: Needs assessment results

6/20/2024 - Kate Mueller

Part 2 of our "Get our docs in a row" series shares the results and takeaways from our internal needs assessment. There were some surprises here!

Get our docs in a row, part 1: Internal needs assessment

Writing docs

6/13/2024 - Kate Mueller

Learn how and why we began our internal knowledge management overhaul with a needs assessment.

Crafting Effective Release Notes

Writing docs

6/6/2024 - Natasha Mahajan

Release notes communicate product updates to users. This guide explains why well-written release notes are important and provides tips for writing effective release notes.

Setting up a knowledge base that has both public and private content

Writing docs Support

5/21/2024 - Erica Beyea

An overview of the benefits and how-tos for creating a knowledge base with both public and private content.

Should your knowledge base be private, public, or a mix of both?

Writing docs

4/9/2024 - Kate Mueller

How to find the right knowledge base software to match your content privacy needs, what to search for and ask about. Includes a link to a software comparison tool.