Writing Docs
Writing Style Guide
MokuDocs should read like product documentation, not like marketing copy.
The writing style across the template is designed to feel calm, direct, and practical. Readers should be able to scan quickly, understand the purpose of a page, and take action without unnecessary explanation.
Voice principles
Be direct
Use clear verbs and straightforward headings.
Be practical
Prioritise useful guidance over abstract commentary.
Be structured
Break long explanations into sections, steps, and patterns readers can scan.
Be specific
Avoid vague claims such as “powerful,” “seamless,” or “robust” unless the page proves them.
Preferred style
short intros
task-oriented headings
concise explanations
examples where decisions could be ambiguous
Avoid
filler phrases
internal implementation language that readers do not need
overexplaining simple concepts
promotional tone inside instructional pages
A good docs page should reduce friction, not add personality for its own sake.