Skip to content

Latest commit

 

History

History
65 lines (50 loc) · 2.42 KB

README.md

File metadata and controls

65 lines (50 loc) · 2.42 KB

文档中心链接

文件名字

- 介绍性文档
  针对一些介绍性文档,我们按语言分类创建比如 软件下载 公司介绍等 我们在对应的zh-CN, zh-TW, en这三个目录创建对应文档和图片素材
- 针对简单产品
一些功能简单的产品我们不会去单独为这个产品
- 针对有独立功能的产品因为我们会为这个产品单独创建github 所以为了尽可能减少重复编辑
 方法一 readme都只放到 文档中心里面, github只放库
 方法二 readme介绍都只放到github,文档中心引用

产品名字

命名规则  
- 如果产品没有型号就直接按功能命名,比如按键那么就:按键模块、LED灯模块、光敏传感器
- 如果产品有核心芯片型号 就功能加芯片型号/或者型号加功能 这个看具体产品命名是否顺口 比如:TTP229矩阵键盘RFID_RC522 LM35温度传感器
- 关于名字大小写问题,有些特殊型号已经约定成俗是大写了比如LM35很少见到lm35这样的描述
但是新产品我们自定义的型号统一大写
- 如果我们的方案已经是原来的名字已经绑定了原来的芯片信号名字,但是在生产国产使用了国产替代完全兼容,这个时候命名延续原来命名型号比如DS1820
- 如果我们的方案已经是原来的名字已经绑定了原来的芯片信号名字,但是在生产国产使用了国产替代不兼容,需要重新定义新型号
- 如果相同型号产品有不同版本请在产品后面加版本号

传感器文档模板

- 白底实物图(600x600)
- 概述
  这个里面一定要把这个产品核心功能点写出来,比如这个灯是高电平是代表触发还是低电平触发,一定要直接了当。信号对应板子上指示灯都是要概述写明白
- 原理图(pdf链接)
  经过公司审核完毕的原理图白底截图(800x800)
- 芯片规格书(PDF链接)
- 参数
  引脚参数
  详细电气参数比如 接口方式 
- 尺寸图
  由硬件工程师 绘制专业全面的尺寸图
- dxf文件,step文件

- arduino IDE使用示例
   - 
   - mixly使用说明
- microbit
   - makecode示例链接  关键块使用说明要清楚
   - microbit micropython库例子
- esp32/掌控版
   - micropython库和示
- K210示例
- 树莓派库和示例

Arduino产品文档模板

Microbit产品文档模板

ESP32产品文档模板