Guides ยท Culture

Documentation Style Guide Basics

Create a light doc style guide

This guide covers building a lightweight documentation style guide: voice/tone, formatting standards, code block rules, templates, and examples to help contributors write consistently.

Define voice and tone

Keep language clear and direct; set preferred terminology.

Formatting rules

Set rules for headings, lists, code blocks, and links for consistency.

Provide templates

Offer doc templates for how-tos, FAQs, and references.

Show examples

Include before/after examples to clarify expectations.

Related Terms