文档规范

1.1 标题

• 文档标题从1级标题开始，根据md语法规范进行顺序编号

• 示例

  标题1

  1.1 标题2

  1.1.1 标题3

  1.1.1.1 标题4

  （1） 标题5

  1）标题6

1.2 图片

• 图片路径: ./img/功能模块名/图片名.png。

  • 在md中请使用相对路径的引用方式
  • 不同功能模块请单独建立文件夹管理图片

• 图片大小: width="50%"

• 图片命名格式: 采用英文，做到见名知意，方便后续文档管理与拓展。

• 示例：

  

1.3 文档项规范

• 功能模块相分离，不同功能模块请单独建立md文档

• 示例：

  

• 注意事项处进行加粗显示。

• 文档面向用户，文档编写时面向场景编写，即用户在使用的时候什么情况下会面临什么问题，针对该问题用户怎样解决，而非单纯对功能进行描述。