add drawing_specification for doc_standard

docs/api_doc_standard/drawing_specification.md

@@ -0,0 +1,105 @@
+作图规范
+
+# 作图规范
+
+包括以下几方面，可点击链接跳转到相应内容。
+
+- 色板
+
+- 程序流程图常用图元
+
+- 程序流程图样例
+
+- 配置流程图常用图元
+
+- 配置流程图样例
+
+- 功能结构图常用的色彩搭配
+
+## 色板
+
+![img](images/drawing_specification/color_series.png)
+
+## 程序流程图常用图元
+
+![img](images/drawing_specification/graph_unit.png)
+
+## 程序流程图样例
+
+![img](images/drawing_specification/pattern_example.png)
+
+### 格式要求
+
+- 字体：中文—微软雅黑，英文—Arial。
+
+- 字号：正文12PT，如有辅助说明，使用10PT
+
+- 横向在同一行的图元高度应相等，纵向在同一列的图元宽度应相等。
+
+- 图元分布间距相等。
+
+- 文字在框中居中。
+
+- 判断框中的文本要简短，文本末尾必须加“？”。
+
+### 设计建议
+
+- 流程图禁止死循环。
+
+- 选定程序流程图的主方向（横向或者竖向），判断分支中的“是”分支都沿着主方向。
+
+- 明确的出口标准。程序流程图中要有单一的入口（一个“开始”）和一个或者多个的出口（一个或者多个“结束”）。
+
+- 流程图中的连线尽量避免交叉。
+
+## 配置流程图常用图元
+
+![img](images/drawing_specification/graph_config_unit.png)
+
+## 配置流程图样例
+
+![img](images/drawing_specification/garph_sample.png)
+
+### 格式要求
+
+- 用户一般的阅读习惯是从左到右，此类横向流程图，为避免流程图超宽，没有开始结束步骤。
+
+- 字体：中文微软雅黑；英文Arial。
+
+- 字号：主任务与子任务字号一样12PT, 如有辅助说明，使用10PT。
+
+- 横向在同一行的图元高度应相等，纵向在同一列的图元宽度应相等。
+
+- 文字在框中居中。
+
+- 图元说明建议放置于流程图右下角，竖版排列。
+
+### 设计建议
+
+- 明确流程中所有的操作以及操作的目的，把所有操作划分为若干步骤。步骤间连线使用“步骤间逻辑箭头”。
+
+- 把每个步骤划分为子步骤，子步骤间可以为先后顺序，也可以为并列顺序。步骤与子步骤间连线使用“步骤分解箭头”。
+
+- 每个子步骤分若干操作，子步骤和操作间连线使用“模块间并列关系线”。
+
+- 每个子步骤下的所有操作用虚线框圈起。
+
+## 功能结构图常用的色彩搭配
+
+![img](images/drawing_specification/color_series.png)
+
+### 格式要求
+
+- 字体：中文—微软雅黑，英文—Arial。
+
+- 字号：正文12PT，如有辅助说明，使用10PT。
+
+- 横向在同一行的图元高度应相等，纵向在同一列的图元宽度应相等。
+
+- 文字在框中居中
+
+- 相等级别的模块，在图形中颜色必须一样。
+
+- 尽量不超过3套颜色
+
+- 模块应使用外框或者或者底框对比明显。

docs/api_doc_standard/write_guide.md

@@ -0,0 +1,242 @@
+# 文档写作要求
+
+## 文档命名
+
+Markdown文件名和图片名使用全小写，单词间可使用_分隔。
+
+## 标题
+
+- 标题仅支持Atx风格，标题与上下文需用空行隔开。
+
+- 标题最多不超过4级（####）。
+
+示例：
+
+```Plaintext
+# 一级标题
+
+## 二级标题
+
+### 三级标题
+```
+
+## github链接
+
+每个Markdown文件添加链到自身的github链接，方便在网页上直接跳转到github页面。
+
+文中使用github链接时，目录应为`https://github.com/paddlepaddle/docs/tree/xxx`，文件应为`https://github.com/paddlepaddle/docs/blob/xxx`。
+
+示例：
+
+```Markdown
+<a href="https://github.com/paddlepaddle/docs/blob/master/tutorials/source_zh_cn/beginner/quick_start.ipynb" target="_blank"><img src="https://github.com/paddlepaddle/docs/raw/master/resource/_static/logo_source.png"></a>
+```
+
+## 概述
+
+要求描述以下内容：
+
+- 主题内容相关技术的背景、介绍以及给用户带来的好处。
+
+- paddlepaddle在各平台的支持情况。
+
+- 完整样例代码的链接。
+
+## 注意事项
+
+注意事项使用“>”标识。
+
+示例：
+
+```Plaintext
+> 注意事项内容。
+```
+
+多条示例：
+
+```Plaintext
+> - 注意事项内容。
+> - 注意事项内容。
+```
+
+受Sphinx工具解析限制，注意事项中只能列举单行代码。
+
+```Plaintext
+> 注意事项内容，`code`。
+```
+
+## 有序/无序列表
+
+- 有序/无序列表下的详细内容需缩进4格写作。
+
+- 标题和内容间需增加一个空行，否则可能无法实现换行。
+
+示例：
+
+~~~Plaintext
+1. 内容1。
+
+    详细说明。
+
+    ```
+    code
+    ```
+
+2. 内容2。
+
+    详细说明。
+
+    ```
+    code
+    ```
+- 内容1。
+
+    详细说明。
+
+    ```
+    code
+    ```
+
+- 内容2。
+
+    详细说明。
+
+    ```
+    code
+    ```
+~~~
+
+## 代码样例
+
+- 教程和文档中不可出现下划线开头的内部接口。
+
+- 注释要求使用英文写作。
+
+- Python函数、方法、类的注释使用`"""`。
+
+- Python其他代码注释使用`#`。
+
+- C++代码注释使用`//`。
+
+示例：
+
+```Plaintext
+"""
+Python函数、方法、类的注释
+"""
+
+# Python代码注释
+
+// C++代码注释
+```
+
+## 图片
+
+- 教程和文档的图片中不出现个人信息。
+
+- 采用Markdown格式写，不要采用html格式写。
+
+- 图和上下文需增加一个空行，否则会导致排版异常。
+
+- 图片放置在临近的images目录下。
+
+示例：
+
+```Plaintext
+![xxx](./xxx.png)
+```
+
+## 表格
+
+- 表格前后需增加一个空行，否则会导致排版异常。
+
+- 采用Markdown格式写，不要采用html格式写。
+
+- 有序或无序列表内不支持表格。
+
+示例：
+
+```Plaintext
+## 文章标题
+
+| 表头1   | 表头2
+| -----   | ----
+| 内容I1  | 内容I2
+| 内容II1 | 内容II2
+
+下文内容。
+```
+
+## 术语
+
+统一术语大小写：PaddlePaddle、CIFAR-10、Python等。
+
+## 参考文献
+
+- 参考文献需列举在文末，并在文中标注。
+
+- 引用文字或图片说明后，增加标注[编号]。
+
+示例：
+
+```Plaintext
+## 参考文献
+
+[1] 作者. [有链接的文献名](http://xxx).
+
+[2] 作者. 没有链接的文献名.
+```
+
+## 格式
+
+- 汉字与英文、数字之间需空格隔开，以增强中英文混排的美观性和可读性。
+
+- 中文标点符号前后不需要跟空格，即使前后挨着的是英文单词。
+
+- 中文里面请使用中文标点符号。英文中没有顿号，应该使用顿号的地方在英文中一般使用的是逗号。
+
+- 教程、文档中引用接口、路径名、文件名等使用“` `”标注，如果是函数或方法，最后不加括号。
+
+- 引用方法示例：
+
+```Plaintext
+使用映射 `map` 方法。
+```
+
+- 引用代码示例：
+
+```Plaintext
+`batch_size`：每组包含的数据个数。
+```
+
+- 引用路径示例：
+
+```Plaintext
+将数据集解压存放到工作区`./MNIST_Data`路径下。
+```
+
+- 引用文件名示例：
+
+```Plaintext
+其他依赖项在`requirements.txt`中有详细描述。
+```
+
+- 教程、文档中待用户替换的内容需要额外标注，在正文中，使用“*”包围需要替换内容，在代码片段中，使用“{}”包围替换内容。
+
+- 正文中示例：
+
+```Plaintext
+需要替换你的本地路径*your_path*。
+```
+
+- 代码片段中示例：
+
+```Plaintext
+conda activate {your_env_name}
+```
+
+## 英文
+
+- 中英文内容需同步修改。
+
+- 英文文档需链英文链接。如将`zh-CN`改成`en`。