// the find
ruanyf/document-style-guide
中文技术文档的写作规范
A style guide for writing Chinese technical documentation, maintained by Ruan Yifeng. Covers headings, punctuation, numbers, paragraph structure, and document organization. Useful if you write technical docs in Chinese and want a consistent baseline to enforce across a team.
Covers the genuinely tricky cases in Chinese technical writing: mixed CJK/Latin punctuation rules, when to use Chinese numerals vs Arabic, spacing between Chinese and English characters. Public domain license means you can copy rules directly into your own internal style guide without attribution. Actively maintained — last update December 2025. Author has high credibility in the Chinese dev community, so teams can cite it externally to settle internal arguments.
Scope is narrow by design: no guidance on API docs, code comments, changelogs, or README structure — just prose formatting. No tooling, linters, or CI integration to actually enforce the rules; it's purely a human document. Non-Chinese teams get nothing from this. The guide is also quite short, so edge cases that come up in real documentation projects are often not covered.