「效率工具」代码即文档，一键生成，秒级同步，助力快捷交付

效率工具集是一套旨在提升产品研发及项目交付过程中开发、设计、配置迁移等流程效率的工具集，包括IDEA插件H-Copilot、表设计、配置迁移、前端扫描、种子数据导出导入、文档生成插件等工具。

我们将提供一系列推文，介绍效率工具的使用，帮助您快速了解本工具，给您更好的使用体验。

本文为系列推文的第七讲，将为大家介绍代码即文档，一键生成，秒级同步，助力快捷交付。

功能亮点

飞码开发插件即将推出一键生成技术文档功能，有效降低技术文档维护工作量，同时支持与源代码秒级同步，增量更新，助力文档制品快捷交付。

• 简单高效，易操作： 配置简单，一键生成，秒级同步，轻松搞定技术文档更新与交付。

• 全面标准，质量高： 文档内容全面覆盖 【文档控制】 、 【目录】 、 【相关知识简介】 、 【总体设计】 、 【详细设计】 以及 【应用信息】 等关键章节。同时自动扫描并生成接口API、数据库表设计、服务配置等扩展信息，确保文档的一致性、全面性与准确性。

应用场景

前置操作：安装Mermaid插件
在生成的技术文档中，ER图、模块关系图等使用Mermaid语法描述，因此需要提前安装Mermaid插件，直接搜索Mermaid安装即可：

场景一：技术文档生成与同步

服务技术文档是对服务功能、架构与使用方式的全面详解，不仅是服务交付和交接的重要组成部分，也是他人了解服务的关键窗口。然而，手工编写此类文档不仅耗时耗力，而且由于个人习惯不同，文档结构往往缺乏统一性。因此，若能快速生成结构规范、内容完整的服务技术文档，既能显著减轻开发人员负担，又有助于提升文档的一致性与专业性，从而全面保障文档质量。

一键快速生成

右键点击工程名称，选择 【HZERO Tools/生成服务技术文档】 ，可维持默认配置，也可以参考使用说明，扩展更多内容，更多可选内容可参考下面的可选配置章节。

点击 【OK】 即可生成当前服务的技术文档，一般将会包含文档控制、目录、概要、相关知识简介、总体设计、详细设计、应用信息等7个章节内容，并支持增量更新，秒级同步。

数据库配置（可选）

如需生成服务数据库表结构信息、ER图等，则需要维护数据源信息。可以在飞码开发插件的【HDB Browser】中提前维护数据源，之后生成文档时选择当前服务的数据库及对应Schema，系统将会根据项目代码中@Table指定的表，生成数据库实体表结构的详细信息。

更多配置（可选）

更多配置是可选的，如果希望生成文档内容更丰富，可按需配置。点击如上 【使用说明】 中的第一条提示信息中的 【请前往编辑】 ，将自动生成并打开 .design-config.yml 配置文件。可配置如下信息：

模块配置： 配置服务包含哪些模块，每个模块包含的API，生成文档时将按模块划分API接口。具体配置项属性含义可看生成配置文档注释。

表关系配置： 配置表与表之间的关联关系，将用于生成ER图。具体配置项属性含义可看生成配置文档注释。

场景二：技术文档导出与交付

确认已安装Pandoc工具，用于将Markdown文档转换为PDF或Microsoft Word文档。具体安装可点击 【Pandoc】链接到官网去下载安装。选中需要转换的Markdown文档，点击工具栏中 【Tools/Markdown/Export Markdown File To...】 即可：

选择需要导出的文档格式，例如，PDF

想了解更多效率工具实际应用场景？请关注后续一系列推文~

欢迎在评论区留言，与我们一起探讨效率工具在您业务中的应用潜力~

联系我们

• 如果您想了解效率工具更详细的功能介绍和产品信息，请登录开放平台查阅我们的产品文档

• 如果您有疑问，可以通过开放平台进行工单反馈，问题分类请选择【产品/汉得基础架构管理平台】

• 相关产品咨询或更多信息了解，欢迎联系我们。邮箱： [e-mail]

立即预约，免费演示 👉 获取产品演示