“文档中心使用帮助”的版本间的差异
(没有差异)
|
2018年11月21日 (三) 06:02的版本
谷雨文档中心是谷雨物联网(开源产品)的在线文档资料库,将逐步提供所有开源产品的文档资料,供用户在线阅读产品资料,或生成PDF文件离线阅读。
1 文档中心包含哪些资料
我们将文档资料归类为下列几种:硬件说明书,软件指导手册,实验指导手册,另外还有非文档的软件工具等。下面以XX来表示产品型号。
- XX硬件说明书。
- 例如《NB200硬件说明书》,介绍NB101(NB-IOT)小系统模块的硬件详情,所有关于该模块的硬件介绍,都可以在该文档中查询到。
- XX软件指导手册。
- 例如《NB200软件指导手册》,介绍NB200的软件操作的详情。
- XX实验指导手册。
- 针对示例源码的实验流程讲解,使用步骤等。
- 软件工具。
- 除了可阅读的文档外,一般都会涉及一些软件工具等不常更新的资料:例如串口调试工具,开发环境IAR或者KEIL,驱动程序,官方芯片或模块手册等。
- 这类资料的特点是文件大,且很少需要更新,因此,我们会提供一个网盘的下载链接,供大家打包下载。
其他未归类的文档,后续将完善说明。
2 产品文档入口
有两种办法访问产品文档的入口。
- 在文档中心浏览器url中输入产品型号
- 例如:http://doc.iotxx.com/NB200
- 即可直达产品资料入口,在该页面下将汇总该开源产品的所有可用资料。
- 在文档中心搜索框中搜索产品型号。
- 例如,搜索NB200
3 归档文件
归档文件是指已经成熟的或者不会再大改动的文档,我们会另外为一个PDF文件,保存在开源产品的软件工具下载链接中。
我们还是建议大家在线浏览,不光快速的查找内容,而且可以方便的浏览相关的文档。
4 移动设备访问
谷雨文档中心提供一个简洁的移动设备访问页面。以适应移动设备的文档阅读。下图是在手机中浏览文档中心的资料。
同时也支持手机端的文档搜索功能,如下图所示: