Introduction

This guide provides a set of style and content guidelines for anyone writing documentation for Rounded.

Goals and audience

The primary goal of this guide is to document decisions that Rounded makes about content.

The guide can help you a. Avoid making decisions about the same issue every time, b. Provide content help on structuring and writing your documentation, and c. Assist you to keep your documentation consistent across all Rounded products.

The audience for this style guide is the founders/co-founders, developers, designers and writers working on Rounded products (web and mobile).

How to use the guide

If you're looking for a specific topic, then do a search-within-page to see if the topic is mentioned in the left navigation (also known as "left nav"). If not, then try using the search box at the top of the page, which is limited by default to search only this guide.

This guide is a reference document; you do not have to always read it in the same order as shown in the left panel.

Exceptions

Remember that everything in this guide is a guideline, not an absolute rule.

Like most style guides, this style guide aims to improve our documentation, especially by improving consistency; therefore, there may be contexts where it makes sense to diverge from our guidelines in order to make the documentation better for our users.