Ruan Yifeng: Writing Specifications for Chinese Technical Documents

Many people say that if they don't know how to write a document, they write it by feeling.

There is also very little information on the Internet to teach you to write documents. This has affected the development of Chinese software.



In the English-speaking world, documentation is highly valued, and many companies and organizations have their own documentation specifications that clearly state the writing requirements, such as Microsoft, MailChimp, Apple, Yahoo, docker, Struts, etc. (Wikipedia has a full list). There are also quite a few in Chinese, but none of them are satisfactory, either too simple or not very applicable.

I started, referring to the above specifications, combined with my own practice, and summed up a simple "Chinese Technical Documentation Writing Specifications".

Title
Text Paragraph Numerical
Punctuation Chapter Structure Below is a snippet on writing style. Issues and PR additions are welcome. ================================== Writing style (from "Chinese Technical Documentation Writing Specifications") if passive Voice, should consider changing to active voice. Do not use informal language styles. Use the correct "的", "地", "to". When using pronouns (such as "the", "the", "this", "this", etc.), it must be clear what it refers to and ensure that there is only one meaning. Click to read the full text: http://click.aliyun.com/m/9973/