What is document-style-guide?

ruanyf/document-style-guide — explained in plain English

Analysis updated 2026-06-24

★ 12,576Audience · writerComplexity · 1/5LicenseSetup · easy

Mindmap

mindmap
  root((document-style-guide))
    What It Covers
      Headings
      Punctuation rules
      Numbers and units
      Document structure
    Language
      Written in Chinese
      For Chinese tech docs
      Consistency rules
    License
      Public domain
      No restrictions
    Audience
      Chinese writers
      Tech bloggers
      Documentation teams

mindmap root((document-style-guide)) What It Covers Headings Punctuation rules Numbers and units Document structure Language Written in Chinese For Chinese tech docs Consistency rules License Public domain No restrictions Audience Chinese writers Tech bloggers Documentation teams

Click or tap to explore — scroll the page freely

What do people build with it?

USE CASE 1

Apply consistent punctuation and heading rules when writing Chinese technical documentation.

USE CASE 2

Use as a shared reference standard for a team writing Chinese developer docs or blog posts.

How does it compare?

	ruanyf/document-style-guide	microsoft/trellis	react-icons/react-icons
Stars	12,576	12,578	12,574
Language	—	Python	TypeScript
Setup difficulty	easy	hard	easy
Complexity	1/5	5/5	1/5
Audience	writer	researcher	developer

Figures from each repo's GitHub metadata at analysis time.

How do you get it running?

Difficulty · easy Time to first run · 5min

No rights reserved, you can use, copy, or adapt this content for any purpose without any restrictions.

So what is it?

This repository is a writing style guide for Chinese technical documentation. It covers rules for headings, body text, paragraphs, numbers, punctuation, document structure, and reference links. The content is written in Chinese and is intended to help writers produce consistent and readable technical documents. The guide is released into the public domain. The README is sparse and does not describe the rules in detail, the full content is spread across linked pages within the repository.

Copy-paste prompts

Prompt 1

Based on the ruanyf document-style-guide, how should I format numbers and units in a Chinese technical article?

Prompt 2

What punctuation rules does the ruanyf Chinese technical writing style guide recommend for parentheses and quotation marks?

Prompt 3

I am writing developer documentation in Chinese, what heading and paragraph structure should I follow according to this style guide?

Frequently asked questions