Documentation Style Guide

This document will serve as the canonical place to define how we write documentation at Read the Docs. The goal is to have a shared understanding of how things are done, and document the conventions that we follow.

Let us know if you have any questions or something isn’t clear.

The brand

We are called Read the Docs. The the is not capitalized.

We do however use the acronym RTD.

Titles

For page titles we use sentence case. This means only proper nouns and the first word are capitalized:

# Good ✅
How we handle support on Read the Docs.

# Bad 🔴
How we Handle Support on Read the Docs

If the page includes multiple sub-headings (H2, H3), we use sentence case there as well.

Content

  • Use :menuselection: when referring to an item or sequence of items in navigation.

  • Use :guilabel: when referring to a visual element on the screen - such as a button, drop down or input field.

  • Use **bold text** when referring to a non-interactive text element, such as a header.

  • Do not break the content across multiple lines at 80 characters, but rather break them on semantic meaning (e.g. periods or commas). Read more about this here.

  • If you are cross-referencing to a different page within our website, use the doc role and not a hyperlink.

  • If you are cross-referencing to a section within our website, use the ref role with the label from the autosectionlabel extension.

  • Use <abstract concept> and <variable> as placeholders in code and URLs. For instance:

    • https://<slug>.readthedocs.io

    • :guilabel:`<your username>` dropdown

  • Make sure that all bullet list items end with a period, and don’t mix periods with no periods.

Word List

We have a specific way that we write common words:

  • Git repository for the place that stores Git repos. We used to use VCS, but this is deprecated.

  • Git provider for generic references to GitHub/Bitbucket/GitLab/Gitea etc. We avoid “host” and “platform” because they are slightly more ambiguous.

  • open source should be lower case, unless you are definitely referring to OSI's Open Source Definition.

  • Git should be upper case. Except when referring to the git command, then it should be written as :program:`git`.

Substitutions

The following substitutions are used in our documentation to guarantee consistency and make it easy to apply future changes.

  • |org_brand| is used for mentioning of .org: Example: Read the Docs Community

  • |com_brand| is used for mentioning of .com. Example: Read the Docs for Business

  • |git_providers_and| is used to mention currently support Git providers with “and”. Example: GitHub, Bitbucket, and GitLab

  • |git_providers_or| is used to mention currently support Git providers with “or”. Example: GitHub, Bitbucket, or GitLab

Glossary

Since the above Word List is for internal reference, we also maintain a Glossary with terms that have canonical definitions in our docs. Terms that can otherwise have multiple definitions or have a particular meaning in Read the Docs context should always be added to the Glossary and referenced using the :term: role.

Using a glossary helps us (authors) to have consistent definitions but even more importantly, it helps and includes readers by giving them quick and easy access to terms that they may be unfamiliar with.

Use an external link or Intersphinx reference when a term is clearly defined elsewhere.

Cross-references

Cross-references are great to have as inline links. Because of sphinx-hoverxref, inline links also have a nice tooltip displayed.

We like to cross-reference other articles with a definition list inside a seealso:: admonition box. It looks like this:

.. seealso::

   :doc:`/other/documentation/article`
     You can learn more about <concept> in this (how-to/description/section/article)

Differentiating .org and .com

When there are differences on .org and .com, you can use a note:: admonition box with a definition list. Notice the use of substitutions in the example:

.. note::

   |org_brand|
      You need to be *maintainer* of a subproject in order to choose it from your main project.

   |com_brand|
      You need to have *admin access* to the subproject in order to choose it from your main project.

If the contents aren’t suitable for a note::, you can also use tabs::. We are using sphinx-tabs, however since sphinx-design also provides tabs, it should be noted that we don’t use that feature of sphinx-design.

Headlines

Sphinx is very relaxed about how headlines are applied and will digest different notations. We try to stick to the following:

Header 1
========

Header 2
--------

Header 3
~~~~~~~~

Header 4
^^^^^^^^

In the above, Header 1 is the title of the article.

Diátaxis Framework

We apply the methodology and concepts of the Diátaxis Framework. This means that both content and navigation path for all sections should fit a single category of the 4 Diátaxis categories:

  • Tutorial

  • Explanation

  • How-to

  • Reference

See also

https://diataxis.fr/

The official website of Diátaxis is the main resource. It’s best to check this out before guessing what the 4 categories mean.

Warning

Avoid minimal changes

If your change has a high coherence with another proposed or planned change, propose the changes in the same PR.

By multi-tasking on several articles about the same topic, such as an explanation and a how-to, you can easily design your content to end up in the right place Diátaxis-wise. This is great for the author and the reviewers and it saves coordination work.

Minimal or isolated changes generally raise more questions and concerns than changes that seek to address a larger perspective.

Explanation

  • Introduce the scope: “This article introduces …” (write this as the very first thing, then consider rewriting it or turning it into an internal comment afterwards).

  • Cross-reference the related How-to Guide. Put a seealso:: somewhere visible. It should likely be placed right after the introduction, and if the article is very short, maybe at the bottom.

  • Consider adding an Examples section.

  • Can you add screenshots or diagrams?

How-to Guides

  • Title should begin with “How to …”, but navigation titles should not contain the “How to” part.

  • Introduce the scope: “In this guide, we will…”

  • Cross-reference related explanation. Put a seealso:: somewhere visible, It should likely be placed right after the introduction and if the article is very short, maybe at the bottom.

  • Try to avoid a “trivial” how-to, i.e. a step-by-step guide that just states what is on a page without further information. You can ask questions like:

    • Can this how-to contain recommendations and practical advice without breaking the how-to format?

    • Can this how-to be expanded with relevant troubleshooting?

    • Worst-case: Is this how-to describing a task that’s so trivial and self-evident that we might as well remove it?

  • Consider if an animation can be embedded: Here is an article about ‘gif-to-video’

Reference

We have not started organizing the Reference section yet, guidelines pending.

Tutorial

Note

We don’t really have tutorials targeted in the systematic refactor, so this checklist isn’t very important right now.

  • Cross-reference related explanation and how-to.

  • Try not to explain things too much, and instead link to the explanation content.

  • Refactor other resources so you can use references instead of disturbing the flow of the tutorial.