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.

How to make release notes count

How to make release notes count
Why are release notes important? Learn how and why to make them content clear, understandable, and most importantly, relevant.Read more

10 tips for making your documentation crystal clear

10 tips for making your documentation crystal clear
How to edit what you've written for technical documentation.Read more

What software documentation can learn from tabletop gaming

What software documentation can learn from tabletop gaming
Tips for better board game instructions are similar to the advice that could be given to documentation writers for today's software.Read more

Getting started with Doctor, the CMS for Markdown documents

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 easy to write and understand, but organizing...Read more

Why I love these markup languages

Why I love these markup languages
Documentation languages are not one-size-fits-all, so picking the right fit for the document being written is crucial.Read more

Technical documentation doesn't have to be dull

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, you can be sure they'll let you know.Read more

Making documentation easy with Read the Docs

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

Documentation should be concise, consistent, and simple

Documentation should be concise, consistent, and simple
Three considerations and accompanying resources to keep in mind as you write documentation.Read more