Writing docs

(238)

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

How to Write Clear and Concise Knowledge Base Articles

8/8/2024 - Hazel Raoult

Learn 8 essential tips for creating effective knowledge base articles. Improve clarity, structure, and searchability to empower users and streamline customer support.

Simplicity in language (and pricing!) can be an act of service

Company culture Writing docs Support

7/26/2024 - Erica Beyea

How KnowledgeOwl veered away from typical software pricing plans, and made their pricing and language around it simpler - to better serve our customers.

How to decide whether to make knowledge base content public or private

Writing docs Support

6/27/2024 - Ayomide Yissa

Learn how to decide between public and private knowledge bases. Explore key factors, pros and cons, and a hybrid approach to optimize information sharing and security for your organization.

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

Writing docs

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.