技术文档写作流程规范

番薯们想要新建文档或者是编辑文档时，有时候不知道该怎么操作或不了解写作的流程规范。

本文将详细介绍新建或编辑文档的方法和流程规范。

2.1 新建文档

1）如下图在帮助文档首页点击创建文档按钮。

2）填写好文档名称，选择文档的目录分类，点击创建文档按钮，如下图所示：

3）选择文档模板，点击确定，即可开始编辑新文档，如下图所示：

系统预定义了 3 种常用的文档架构，用户新建的文档类型如果对应这些架构可以直接套用，也可以直接使用空白文档编辑，预定义架构对应文档类型如下：

• 任务类：阐述完成某个特定任务所需要的步骤，例如：实现某个图表的文档。

• 概念类：介绍产品功能或者实际的应用文档，例如：图表类的文档。

• 故障排查类：描述产品使用过程中遇到的问题和解决方案，例如：服务器部署常见问题类的文档。

• JS 类：JS 二开文档专属模板

• 插件类：插件文档专属模板
  

2.2 编辑文档

打开一篇文档，鼠标悬浮在文档标题右边的上，然后点击编辑按钮即可进入文档编辑模式，如下图所示：

文档写作遵循的原则为：语言精炼，突出重点，架构清晰，层次分明。

文档写作需要遵循 2 个规范，分别如下：

文档中的用词需要遵循：通用词规范

文档中的配图需要遵循：文档图示规范

文档写完后，点击发布按钮，文档变为未审核状态，等待管理员审核过后即可对外展示了。