Doc Dish column

The Doc Dish community column is dedicated to documentation, including best practices, case studies, open source projects that need documentation contributions, events, tools, and tips. Do you have a story idea? Submit your proposal.

Documentation based on user stories

There are numerous approaches to writing documentation, but one of the fundamental distinctions a...
How to make release notes count

Why are release notes important? Learn how and why to make them content clear, understandable, and...
10 tips for making your documentation crystal clear

How to edit what you've written for technical documentation.
What software documentation can learn from tabletop gaming

Tips for better board game instructions are similar to the advice that could be given to...
Getting started with Doctor, the CMS for Markdown documents

Markdown is one of most popular document formats among developers and non-developers alike. It is...
Why I love these markup languages

Documentation languages are not one-size-fits-all, so picking the right fit for the document being...
Technical documentation doesn't have to be dull

Think about the kind of documentation you like to read, and write that. If people don't like it,...
Introduction to Read the Docs

Find out how Read the Docs aims to make documentation a little easier.