...

• Be consistent
• Keep it simple but technically correct
• Be proactive and suggest good practices
• Be informative and exhaustivebut concise
• Be inclusive

1. Be consistent

...

To provide additional detail, use sub-sections.

5. Be Inclusive

Consider that users who will read the docs are from different background and cultures and that they have different sensitivities.

Avoid potential offensive terms and, for instance, prefer "allow list and deny list" to "white list and black list".

We believe that we all have a role to play to improve our world, and even if writing inclusive doc might not look like a huge improvement, it's a first step in the right direction.

We suggest to refer to Google inclusive doc writing guide and Microsoft bias free writing guidelines as starting points.

Writing style guide

We use the Microsoft Style Guide as our general guide to writing technical documentation. We take guidance from it but do not apply every rule. For example, we use title case rather than sentence case.

...