File tree 1 file changed +31
-3
lines changed
1 file changed +31
-3
lines changed Original file line number Diff line number Diff line change 1
- # 章节结构
1
+ # 文档体系
2
+
3
+ ## 结构
2
4
3
5
软件手册是一部完整的书,建议采用下面的结构。
4
6
9
11
- ** 安装** (Installation):[ 可选] [ 文件] 软件的安装方法
10
12
- ** 设置** (Configuration):[ 必备] [ 文件] 软件的设置
11
13
- ** 进阶篇** (Advanced):[ 可选] [ 目录] 又称”开发篇“,提供中高级的开发教程
12
- - ** API** (Reference):[ 可选] [ 目录|文件] 软件API的逐一介绍
14
+ - ** API** (Reference):[ 可选] [ 目录|文件] 软件 API 的逐一介绍
13
15
- ** FAQ** :[ 可选] [ 文件] 常见问题解答
14
16
- ** 附录** (Appendix):[ 可选] [ 目录] 不属于教程本身、但对阅读教程有帮助的内容
15
17
- ** Glossary** :[ 可选] [ 文件] 名词解释
18
20
- ** ChangeLog** :[ 可选] [ 文件] 版本说明
19
21
- ** Feedback** :[ 可选] [ 文件] 反馈方式
20
22
21
- ** 范例 **
23
+ 下面是两个真实范例,可参考。
22
24
23
25
- [ Redux 手册] ( http://redux.js.org/index.html )
24
26
- [ Atom 手册] ( http://flight-manual.atom.io/ )
27
+
28
+ ## 文件名
29
+
30
+ 软件手册的文件名,必须使用半角字符,不得使用全角字符。这也意味着,中文不能用于文件名。
31
+
32
+ ```
33
+ 错误: 名词解释.md
34
+
35
+ 正确: glossary.md
36
+ ```
37
+
38
+ 文件名必须使用小写字母,不得使用大写字母。
39
+
40
+ ```
41
+ 错误:ChangeLog.md
42
+
43
+ 正确:changelog.md
44
+ ```
45
+
46
+ 文件名包含多个单词时,单词之间建议使用半角的连词线(` - ` )分隔。
47
+
48
+ ```
49
+ 不佳:advanced_usage.md
50
+
51
+ 正确:advanced-usage.md
52
+ ```
You can’t perform that action at this time.
0 commit comments