应用手册编写规范

1 命名规则

1.1 文件夹命名规则

文件夹以具体应用手册名称的英文翻译命名，只包含数字、下划线“_”、小写英文字母。

1.2 文件命名规则

情况一：单篇 md 文件的应用手册

如果应用手册内容较短，可考虑使用一篇 Markdown 文件承载，则该 Markdown 文件命名为 index，例如：

user_manual                               # 根目录
│
├─ example_manual_zh                      # 示例应用手册（中文版）
│   ├── index.md                          # 手册正文             
│   └── pics                              # 存放手册中需要的图片（中文）
│       ├── new_fold.png
│       ├── configure.png
│       └── ...
│
├─ example_manual_en                      # 示例应用手册（英文版）
│   ├── index.md                          # 手册正文             
│   └── pics                              # 存放手册中需要的图片（英文）
│       ├── new_fold.png
│       ├── configure.png
│       └── ...
│
├── example_2_manual_zh                   # 示例应用手册 2（中文版）              
│   ├── index.md                          # 手册正文             
│   └── pics                              # 存放手册中需要的图片（英文）
│       ├── wait_time.png
│       ├── out_time.png
│       └── ...
└── ...

情况二：多篇 md 文件的应用手册

如果应用手册内容较多，可按章节内容分为多篇文档，甚至按章节构建文件夹，每一个子章节为一篇单独的 Markdown 文件（注意：文件层级不超过三级），则每篇 Markdown 文件以当前章节标题的英文翻译命名，并按照章节顺序增加序号，例如：

user_manual                               # 根目录
│
├─ example_manual_zh                      # 示例应用手册（中文版）
│   ├── 00_preface.md                     # 第 1 章 前言   
│   ├── 01_introduction.md                # 第 2 章 简介
│   ├── 02_safe.md                        # 第 3 章 安全
│   ├── ...
│   └── pics                              # 存放手册中需要的图片（中文）
│
├─ example_manual_en                      # 示例应用手册（英文版）
│   ├── 00_preface.md                     # 第 1 章 前言   
│   ├── 01_introduction.md                # 第 2 章 简介
│   ├── 02_safe.md                        # 第 3 章 安全
│   ├── ...
│   └── pics                              # 存放手册中需要的图片（英文）
│
│
├── example_2_manual_zh                   # 示例应用手册 2（中文版） 
│   ├── 00_preface                        # 第 1 章 前言
│   │   ├── 00_preface.md                 # 1.1 关于本手册
│   │   ├── 01_safe.md                    # 1.2 安全
│   │   ├── 02_introduction.md            # 1.3 从这里开始
│   │   └──...
│   ├── 01_quick_start                    # 第 2 章 快速开始
│   │   ├── 00_preface.md                 # 1.1 关于本手册
│   │   ├── 01_safe.md                    # 1.2 安全
│   │   ├── 02_introduction.md            # 1.3 从这里开始
│   │   └──...
│   ├── ...    
│   | 
│   └── pics                              # 存放手册中需要的图片（中文）
│       ├── wait_time.png
│       ├── out_time.png
│       └── ...
│
├── example_2_manual_en                   # 示例应用手册 2（英文版） 
│   ├── 00_preface                        # 第 1 章 前言
│   │   ├── 00_preface.md                 # 1.1 关于本手册
│   │   ├── 01_safe.md                    # 1.2 安全
│   │   ├── 02_introduction.md            # 1.3 从这里开始
│   │   └──...
│   ├── 01_quick_start                    # 第 2 章 快速开始
│   │   ├── 00_preface.md                 # 1.1 关于本手册
│   │   ├── 01_safe.md                    # 1.2 安全
│   │   ├── 02_introduction.md            # 1.3 从这里开始
│   │   └──...
│   ├── ...    
│   | 
│   └── pics                              # 存放手册中需要的图片（英文）
│       ├── wait_time.png
│       ├── out_time.png
│       └── ...
└── ...

2 文档编写规范

参见 文档编写规范

3 文档图片规范

参见 文档图片规范

4 附件/下载文件规范

安装包/应用包等，用户需下载的文件，须提供下载中心的下载链接。

示例工程/示例代码文件，须提供公司 Gitee 工程的链接。

其他类型附件暂未提供方案，请联系项目负责人和产品经理。