Document writing specification

Write it at the front ：

​ In daily work , I often tidy up “SDK  Access instructions ” and “ Summary of experience ” Related documents . These documents should not only be provided to customers , I often refer to them when I work . So the document is written accurately and beautifully , Particularly important . The following are all dry goods , To see is to earn ！

1、 Serial number , Conform to the hierarchical order

The upper and lower level headings must conform to the hierarchical order , There is no disconnection .

first floor ： One 、 Two 、 3、 ... and 、
The second floor ：（ One ）（ Two ）（ 3、 ... and ）
The third level ：1. 2. 3.  or  1、2、3、
The fourth level ：（1）（2）（3）
The fifth floor ：①②③  or  1）2）3）
The sixth floor ：A. B. C.  or  （A）（B）（C）
The seventh floor ：a. b. c.  or  （a）（b）（c）

2、 The colon , Unified use

Or both , Or not at all , Do not jump to use .

  Examples of errors are as follows

Title 1 、XXXX:
Heading two 、XXXX
Heading three 、XXXX

3、 Catalog , Add as appropriate

When the document is long , In order to let readers quickly understand what the content is , Insert the directory properly .

4、 In red , Less and better

Less but better is more important , Don't abuse the red font .

  Examples of errors are as follows

5、 data , accuracy

For example, percentage data , Be sure to add up to  100%, Make sure you round it ;

  Examples of errors are as follows

6、 Multiple pieces of content , Unified word order

The full text unifies what module to say first , What module does it say .

7、 Summative words , Appropriate to add

Before some operation instructions , Add concluding words , It will be easier to know what to do in the future .

  Examples of errors are as follows

8、 flow chart , Simple and clear

Try not to make the flow chart look too complicated 、 The color is too harsh .

  Examples of errors are as follows

9、 Colloquial , Avoid

Avoid colloquial descriptions .

  Examples of errors are as follows

If you have any questions in the reading process , Welcome to leave a message in the comments area to participate in the discussion ！