Doc Dish column Doc Dish column feed

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.

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.
Documentation should be concise, consistent, and simple

Three considerations and accompanying resources to keep in mind as you write documentation.
typewriter keys

Learn how three tests can help you improve the readability of your documentation.