插件文档撰写规范

1. 文档撰写

1.1 结构模板

文档撰写模板：插件文档撰写结构

1.2 内容要求

1）文档中需要设置相对完整的表单场景。如自动获取流程状态插件，需要设置相对完整的流程，可以是请假流程、物品领用申请流程等。不能在表单中仅设置一个表示流程状态的字段。

2）文档中录入相关数据时，需要使用合理完整的模拟数据，不可使用无意义、残缺的测试数据。

3）预期效果处需给出插件执行成功的效果图。

2. 使用工具

2.1 截图工具

为了避免出现色差，建议使用电脑自带的快捷键截图：

2.2 图片制作工具

2.3 动图工具

动图录制工具：

3. 标注规范

3.1 截图规范

1）图越清晰越好，如果需要截很小的一个区域的图而又截不清晰，建议将浏览器放大了再截，尽量清晰。

2）截图时需要注意图不能太宽，不可以将浏览器全屏后截图，这样会导致放在帮助中心后看不清。

3）保持边缘整齐，边缘尽量在空白位置，且上下左右留白尽量一致。

4）录制动图时，尽量控制在15s之内。

3.2 Figma标注模板

点击下载：图片标注模板.fig

Figma使用方法可参考：Figma使用方法