Product Documentation Writing Guidelines
·
1 min read
·
140
Words
·
-Views
-Comments
Beyond in‑product help, we publish standalone product docs. Here are conventions I learned while writing docs at my company.
Use respectful “您” rather than “你”.
Avoid arrows in screenshots; mosaics and red highlight boxes are fine.
Include static images and animated GIFs where helpful.
External links are okay.
End sentences with periods, including bullet items.
Start each document with a brief overview.
Steps should begin after login and include the full path to the feature, not just a partial step.
In Chinese docs, add spaces around embedded English words.
Bold action nouns (menu items, buttons) to highlight them.
Use full‑width punctuation (colons, parentheses) for Chinese; half‑width for English.