打开主菜单

谷雨文档中心 β

文档管理

Ghostyu讨论 | 贡献2018年10月12日 (五) 15:01的版本
(差异) ←上一版本 | 最后版本 (差异) | 下一版本→ (差异)

文档管理非常重要,正确的命名和分类可以帮助用户快速的找到所需内容,因此,我们有必要建议一套文档管理规则。

可以借鉴已有的成功案例,再结合我们自身的文档特点,特建立此规则。

1 谷雨物联网的文档特点

由于都是技术类的文档,差不多有下面几点特点。

  • 芯片(模组)相关的说明文档。例如芯片手册,模组的指令手册等
  • 小系统板的说明文档。例如NB101使用手册,云平台使用手册,NBTool使用说明书等。
  • 开发板的教程。开发板硬件说明书,软件开发指导,代码配套说明,常见问题,更新记录等。

技术的文档往往需要相互依赖,相互参照,或者引用其他技术说明等,这也正是我们使用在线文档的初衷之一。

鉴于上述特点,首先要创建相关的分类,按照设备型号,芯片型号,网络类型等,同一个文档可能拥有多个分类,但务必是密切相关的分类。

可用的分类可能有:BluetoothLE(BLE),NB-IOT,而BluetoothLE(BLE)可能有包含CC2540,CC2640等等。

2 文档的分类

按照文章的技术类型分类:

  • BLE
  • WiFi
  • NB-IOT
  • ZigBee
  • 等等

按照文章的内容性质分类:

  • 手册(说明书,硬件手册,软件手册,实验手册,简明介绍,数据手册Datasheet)
  • 源码(注:在文章中提供源码下载连接和更新说明)
  • 视频(注:在文章直接观看在线视频)
  • 硬件资源(原理图,封装库等。)
  • 开发工具(编译工具,下载工具,在线工具等)

按产品型号分类:

  • NB101
  • NB200
  • NB-EK-L476
  • 等等