Editing the Docs

Conceptual Notes

Use short titles when possible

Before

After

Diffgram Opensource Quickstart Install

Install

Diffgram Architecture Overview

Architecture

When possible the title of the doc should be as short as reasonably possible. While Diffgram, Open Source, etc. are all fine to mention in the article itself, the title should be as short and readable as possible. Remove filler words when possible.

Use Nested Pages

Readme.com works best with nested docs, otherwise the left panel grows larger and larger

Test Search

The document should come up under expected search terms.

Use Placeholder Pages

Be Aware of Document Order

As we add more documents, documents, and sometimes whole sections get pushed further and further down the page. Consider what a new user sees.


Did this page help you?