Movatterモバイル変換

[0]ホーム
URL:

Skip to content

Navigation Menu

Sign in
Appearance settings

Search code, repositories, users, issues, pull requests...

Provide feedback

We read every piece of feedback, and take your input very seriously.

Saved searches

Use saved searches to filter your results more quickly

 Sign up
Appearance settings

Commit06d108a

Browse files
authored
docs: add file name standard
1 parent4152ad7 commit06d108a

File tree

1 file changed

+31
-3
lines changed

1 file changed

+31
-3
lines changed

‎docs/structure.md

Lines changed: 31 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,6 @@
1-
#章节结构
1+
#文档体系
2+
3+
##结构
24

35
软件手册是一部完整的书，建议采用下面的结构。
46

@@ -9,7 +11,7 @@
911
-**安装**（Installation）：[可选][文件] 软件的安装方法
1012
-**设置**（Configuration）：[必备][文件] 软件的设置
1113
-**进阶篇**（Advanced)：[可选][目录] 又称”开发篇“，提供中高级的开发教程
12-
-**API**（Reference）：[可选][目录|文件]软件API的逐一介绍
14+
-**API**（Reference）：[可选][目录|文件]软件 API 的逐一介绍
1315
-**FAQ**：[可选][文件] 常见问题解答
1416
-**附录**（Appendix）：[可选][目录] 不属于教程本身、但对阅读教程有帮助的内容
1517
-**Glossary**：[可选][文件] 名词解释
@@ -18,7 +20,33 @@
1820
-**ChangeLog**：[可选][文件] 版本说明
1921
-**Feedback**：[可选][文件] 反馈方式
2022

21-
**范例**
23+
下面是两个真实范例，可参考。
2224

2325
-[Redux 手册](http://redux.js.org/index.html)
2426
-[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+
```

0 commit comments

Comments
 (0)
[8]ページ先頭
©2009-2025 Movatter.jp