乐于分享
好东西不私藏

信息化项目验收,交付文档里的图你都是怎么画的?

信息化项目验收,交付文档里的图你都是怎么画的?

参与过信息化项目交付的人都知道,验收阶段最麻烦的不是代码,是文档。

而文档里最耗时间的,除了写文字,就是画图。


交付文档到底要交哪些图?

根据多个政务信息化项目的验收要求,交付文档一般包含以下图表:

系统架构文档

  • 系统总体架构图(分层架构)
  • 技术架构图(技术选型+模块关系)
  • 网络部署架构图(服务器+网络拓扑)

运维手册

  • 系统监控流程图
  • 故障处理流程图
  • 备份恢复流程图

操作手册

  • 业务操作流程图
  • 权限管理流程图

数据文档

  • 数据流转图
  • 系统间数据交互时序图

一个中等规模的项目,交付文档里的图表数量通常在20%—40%张之间。


实际情况是什么样的?

大部分团队的开发流程是这样的:

阶段
文档状态
图表状态
需求阶段
需求文档有文字描述
流程图画了草图,没整理
设计阶段
设计文档有架构描述
架构图画在白板上,拍了照片
开发阶段
架构改了好几版
图早就和实际代码对不上了
验收阶段
文字拼一拼还能用
图必须重新画

问题就在这:文字可以边做边写,图没法边做边画。到了验收阶段,文字文档东拼西凑还能交差,但图表缺了就是缺了,甲方一看就知道。


常见的补图方式及问题

方式一:从PPT里截图项目汇报时做过的PPT里通常有一些架构图和流程图,截图贴到文档里。

  • 问题:分辨率低、格式不统一、打印出来模糊
  • 甲方反馈:文档要可编辑的,截图不行

方式二:用Visio从头画打开Visio,对着设计文档的文字描述,一个个节点拖、一根根线连。

  • 问题:补一个文档图至少要1-2天,验收阶段通常时间紧
  • 如果架构在开发阶段改过,还要先理清当前的架构再画

方式三:找设计阶段的白板照片照着画翻出当时开会拍的白板照片,在Visio里照着重画一遍。

  • 问题:白板照片通常模糊、不完整,还是要靠回忆补全

这三种方式都绕不开一个问题:你已经有文字描述了(在设计文档、需求文档里),为什么还要手动把文字"翻译"成图?


一种更直接的做法

最近在补一个项目的交付文档时,试了一个方法:直接用文档里已有的文字描述生成Visio图表。

我用的是OpenVS这个工具,原理很简单——把流程的文字描述粘贴进去,自动生成.vsdx文件。

以操作手册里的故障处理流程为例,文档里的文字本来就要写进操作手册,不需要额外创作。粘贴到工具里:

生成过程大约10秒:

下载.vsdx文件,用Visio打开:

从生成结果看:

  • 主流程、分支判断、子流程、节点连线和箭头方向等流程图设计的与文本内容基本准确

不是完美版,需要在Visio里做些调整:

  • 拖动节点优化间距
  • 修改个别节点文字,统一用词

一张图从文字到成图,可能就1分钟。


架构图:从草图到Visio文件

系统架构图的情况稍有不同。开发阶段通常在白板上画过草图,或者PPT里有过简版架构图。

OpenVS支持上传图片直接转成Visio文件:

上传架构图照片:

等待生成完成。

下载打开后,可以在Visio中编辑:

图片转绘的准确度取决于原图质量。白板照片清晰、字迹工整的话,识别效果不错;如果照片模糊或草图太潦草,需要更多手动修正。


实际补图流程

总结一下,用这个方法补交付文档图表的流程:

  1. 列清单:对照验收要求,列出缺哪些图
  2. 找文字:在设计文档、需求文档、运维手册里找到对应的文字描述
  3. 生成图:文字粘贴到OpenVS,生成.vsdx文件
  4. 微调:在Visio里调整布局和措辞
  5. 图片转绘:架构图如果有白板照片或PPT截图,用图片生成功能转换

一个文档图,原来1-2天的工作量,压缩到十几分钟调整完。


需要注意的问题

这个方法不是万能的,有几个限制:

1. 文字描述要结构化,越详细的文字描述,AI越能正确识别流程逻辑。如果文字写得很模糊,生成的图也会模糊。

2. 生成后必须检查,AI偶尔会遗漏节点或连错线,花1分钟逐个节点检查一遍。

3. 复杂网络拓扑图不适合需要精确标注IP地址、设备型号的网络拓扑图,还是得手动画。

4. 需要Visio环境生成的.vsdx文件需要Microsoft Visio 2016及以上版本。

5. 需要联网AI模型在线调用,没网络用不了。


小结

交付文档缺图是信息化项目验收中的常见问题。核心矛盾是:文字文档可以边做边写,图表却往往拖到验收阶段才画。

如果文档里已经有了流程的文字描述,用文字生成图表的方式可以省掉大量重复劳动。不是替代Visio,而是在Visio之前加了一步——把文字快速变成图的基础框架,再在Visio里精修。

这个开源工具的地址:https://yyjuan97.github.io/openvs.github.io/


有更好的交付文档补图方法,欢迎交流。