MBT文档模型化生成工具软件
详情
可通过邮件、留言等方式,留下您的基本信息和邮件地址,协商软件购买事宜。
一、简述
MBT文档生成工具极大提高文档工作效率。针对通用文档、产品研发工程文档、多格式输出、工程化管理等工作中的实际问题,提供完整的解决方案。特别增加了对GJB438B-2009 军用软件开发文档通用要求、GJB 438C-2021 软件开发文档通用要求标准的支持,可定制扩展其他文档标准支持。
(一)通用文档
针对通用文档,主要支持解决下列问题:
(1)模板格式定制,支持各类公文行文格式定制,防止因文档格式调整变化导致的重新修改调整。
(2)团队协作人员之间文档样式、格式不统一,编辑、合并、分块工作耗费大量时间。
(3)表格制作、图形绘制工作量大,耗费大量时间。
(4)段落、插图、表格、题注、引用、目录、编号、页码、样式等文档要素要进行正确美观的格式调整和控制,耗费大量时间。
(5)文档内容多、格式复杂时,编辑、保存Word文档都需要一定的等待时间。
(二)产品研发工程文档
在产品研发工程中,典型的如软件工程领域,通常需要撰写实施方案、需求分析、软件设计、测试大纲、测试报告、验收大纲、用户手册等,文档撰写的工作量巨大。主要支持:
(1)内容丰富,能够体现整个工程大部分信息。
(2)专门的工程文档格式要求。
(3)同一项目中,文档之间联系紧密,有的内容要求一一对应,其中往往包括大量重复出现的信息。
(4)同一文档中,各章节之间,隐含了组成、从属关系信息。
(5)需要制作各种表格,绘制各种图形,包括各类UML图。
(6)与源代码共存,方便版本管理。
(7)提供各种配套工具,包括语音朗读、文档对比图文查重、错别字检测等。
(三)多格式输出
针对实际工作对不同文档格式要求。例如:文档提交和打印要求使用docx、pdf格式,产品文档要求使用html、chm、Qt帮助,演示汇报要求使用pptx。实现文档一次撰写,多种格式输出。主要支持docx、pdf、html、chm、qch、pptx等格式输出。
(四)工程化管理
解决Word文件版本管理、内容比较、内容合并、内容恢复的难点问题。
解决Word文档作为一个二制制格式,难以采用软件工程方法论和工具链,从而对文档开发实施工程化管理。
支持团队人员之间统一文档样式模板,易于分块协作、版本管理、成果合并。
二、 关键技术
(一)文档模型化
综合分析各类文档要素,构建文档模型,设计简洁的脚本指令描述文档,总体上易于阅读和编辑。略...
(二)文档表格化
略...
(三)文档工程化
MBT工具是实现复杂大型文档撰写工程化管理的核心环节。文档模型化使文档变成了类似软件代码的文本文件,因此可以借鉴软件工程理念、应用成熟的软件工程工具链,实现文档撰写工程化,极大提高文档工作的效率。具体的环节和对应的工具主要有以下几种。
需求管理,采集提炼用户需求,形成需求条目文档,指导文档撰写。
文档设计,确定使用的文档模板和文档内容框架结构,划分文档内容模块,将文档块,分配到不同的项目组成员,分工协作开展工作。
版本管理,用SVN或GIT版本管理工具,管理文档各版本,包括不同人员在不同时间、不同地点撰写的文档版本。
版本比较和合并,使用BeyondCompare、UltraCompare或WinMerge等工具之一,比较不同版本文档之间的差异,合并消除差异。
同行评审(Review),使用Review board、Gerrit、CodeStriker、Code Review Tool等工具之一,由项目组或各级负责人员实施文档检查和评审。
缺陷跟踪(Bug trace),使用JIRA、BugZilla、Bugtracker等工具之一,对发现的问题进行跟踪,直到问题解决。
自动构建,将一个组织内部的全部文档每天自动构建为目标文档,并收集分析构建过程中发现的问题。
采用GitLab 服务系统,用于文档仓库管理,使用Git作为文档代码管理工具,可一站式实现上述软件工程工具功能。文档在最后完成交付时,需要统一润色。
三、 软件系统组成
MBT文档生成工具由图形编辑界面程序和编译处理程序两部分组成。一般情况下,用户只需要使用DocEditor编辑器即可。高级用户可使用编译处理程序,实现一些自动化的文档处理调用。
MBT文档生成工具提供了易用的图形编辑界面。
左边是章节树,点击章节节点,可以在编辑器中选中相应的章节,右键菜单中,可查找章节,拷贝、粘贴、删除章节。
支持常用文档脚本的插入。支持常用文档脚本的插入。
支持在Windows资源管理器中,选中图像文件、Word文件、mbt、txt文件,拖放到窗口中。
用户可选择一个其它编辑工具,如Editplus 4、UltraEdit、Visual Studio 2013、Visual Code、Sublime等,使用命令行指令生成,或者用MBT文档生成工具编辑器打开再生成,获得输出结果文档。
MBT文档生成工具提供了基本的文档校对功能,能够检查文档中的中文文字错误。还可提供联机错别字检查、英中和中英翻译功能。
软件版本和功能模块
四、常用文档工具对比
当前常用几种文档工具中,Word/WPS,是目前最主流的工具,功能强,可读性较好;文档撰写效率较低;文档工程化管理困难。Latex,一般用于发表国外高等级学术期刊,专业化程度高;可读性较差;模板定制困难,难以转换到各级机关定制格式的文档。Markdown,是目前互联网上最流行的方法,可读性较好,接近MBT;但模板定制困难,难以转换到各级机关定制格式的文档。
MBT在借鉴Markdown优点的基础上,针对实际工作需要,进一步优化指令,优化方法论,开发辅助工具。几种技术对比如下表。
|
可读性 |
撰写效率 |
模板定制 |
机关格式支持 |
文档工程化 |
Word/WPS |
优 |
差 |
优 |
优 |
差 |
Latex |
差 |
差 |
良 |
差 |
良 |
Markdown |
优 |
良 |
良 |
差 |
优 |
MBT |
优 |
优 |
优 |
优 |
优 |
联系人: | 余工 |
---|---|
电话: | 13521660992 |
Email: | anbsim@foxmail.com |
微信: | anbsim |