文档体系
- 简介(Introduction): [必备] [文件] 提供对产品和文档本身的总体的、扼要的说明
- 快速上手(Getting Started):[可选] [文件] 如何最快速地使用产品
- 入门篇(Basics): [必备] [目录] 又称”使用篇“,提供初级的使用教程
- 安装(Installation):[可选] [文件] 软件的安装方法
- 设置(Configuration):[必备] [文件] 软件的设置
- 进阶篇(Advanced):[可选] [目录] 又称”开发篇“,提供中高级的开发教程
- API(Reference):[可选] [目录|文件] 软件 API 的逐一介绍
- FAQ:[可选] [文件] 常见问题解答
下面是两个真实范例,可参考。
文件名
文件名必须使用半角字符,不得使用全角字符。这也意味着,中文不能用于文件名。
为了醒目,某些说明文件的文件名,可以使用大写字母,比如、。