MBT文檔模型化生成工具軟件
詳情
可通過郵件、留言等方式,留下您的基本信息和郵件地址,協(xié)商軟件購買事宜。
一、簡述
MBT文檔生成工具極大提高文檔工作效率。針對通用文檔、產(chǎn)品研發(fā)工程文檔、多格式輸出、工程化管理等工作中的實(shí)際問題,提供完整的解決方案。特別增加了對GJB438B-2009 軍用軟件開發(fā)文檔通用要求、GJB 438C-2021 軟件開發(fā)文檔通用要求標(biāo)準(zhǔn)的支持,可定制擴(kuò)展其他文檔標(biāo)準(zhǔn)支持。
(一)通用文檔
針對通用文檔,主要支持解決下列問題:
( 1)模板格式定制,支持各類公文行文格式定制,防止因文檔格式調(diào)整變化導(dǎo)致的重新修改調(diào)整。
( 2)團(tuán)隊(duì)協(xié)作人員之間文檔樣式、格式不統(tǒng)一,編輯、合并、分塊工作耗費(fèi)大量時(shí)間。
( 3)表格制作、圖形繪制工作量大,耗費(fèi)大量時(shí)間。
( 4)段落、插圖、表格、題注、引用、目錄、編號、頁碼、樣式等文檔要素要進(jìn)行正確美觀的格式調(diào)整和控制,耗費(fèi)大量時(shí)間。
( 5)文檔內(nèi)容多、格式復(fù)雜時(shí),編輯、保存 Word文檔都需要一定的等待時(shí)間。
(二)產(chǎn)品研發(fā)工程文檔
在產(chǎn)品研發(fā)工程中,典型的如軟件工程領(lǐng)域,通常需要撰寫實(shí)施方案、需求分析、軟件設(shè)計(jì)、測試大綱、測試報(bào)告、驗(yàn)收大綱、用戶手冊等 ,文檔撰寫的工作量巨大。主要支持:
( 1)內(nèi)容豐富,能夠體現(xiàn)整個工程大部分信息。
( 2)專門的工程文檔格式要求。
( 3)同一項(xiàng)目中,文檔之間聯(lián)系緊密,有的內(nèi)容要求一一對應(yīng),其中往往包括大量重復(fù)出現(xiàn)的信息。
( 4)同一文檔中,各章節(jié)之間,隱含了組成、從屬關(guān)系信息。
( 5)需要制作各種表格,繪制各種圖形,包括各類 UML圖。
(6)與源代碼共存,方便版本管理。
(7)提供各種配套工具,包括語音朗讀、文檔
對比圖文查重、錯別字檢測等。
(三)多格式輸出
針對實(shí)際工作對不同文檔格式要求。例如:文檔提交和打印要求使用 docx、 pdf格式,產(chǎn)品文檔要求使用 html、 chm、 Qt幫助,演示匯報(bào)要求使用 pptx。實(shí)現(xiàn)文檔一次撰寫,多種格式輸出。主要支持 docx、 pdf、 html、 chm、 qch、 pptx等格式輸出。
(四)工程化管理
解決 Word文件版本管理、內(nèi)容比較、內(nèi)容合并、內(nèi)容恢復(fù)的難點(diǎn)問題。
解決 Word文檔作為一個二制制格式,難以采用軟件工程方法論和工具鏈,從而對文檔開發(fā)實(shí)施工程化管理。
支持團(tuán)隊(duì)人員之間統(tǒng)一文檔樣式模板,易于分塊協(xié)作、版本管理、成果合并。
二、 關(guān)鍵技術(shù)
(一) 文檔模型化
綜合分析各類文檔要素,構(gòu)建文檔模型,設(shè)計(jì)簡潔的腳本指令描述文檔,總體上易于閱讀和編輯。略...
(二) 文檔表格化
略...
(三) 文檔工程化
MBT工具是實(shí)現(xiàn)復(fù)雜大型文檔撰寫工程化管理的核心環(huán)節(jié)。文檔模型化使文檔變成了類似軟件代碼的文本文件,因此可以借鑒軟件工程理念、應(yīng)用成熟的軟件工程工具鏈,實(shí)現(xiàn)文檔撰寫工程化,極大提高文檔工作的效率。具體的環(huán)節(jié)和對應(yīng)的工具主要有以下幾種。
需求管理,采集提煉用戶需求,形成需求條目文檔,指導(dǎo)文檔撰寫。
文檔設(shè)計(jì),確定使用的文檔模板和文檔內(nèi)容框架結(jié)構(gòu),劃分文檔內(nèi)容模塊,將文檔塊,分配到不同的項(xiàng)目組成員,分工協(xié)作開展工作。
版本管理,用SVN或GIT版本管理工具,管理文檔各版本,包括不同人員在不同時(shí)間、不同地點(diǎn)撰寫的文檔版本。
版本比較和合并,使用BeyondCompare、UltraCompare或WinMerge等工具之一,比較不同版本文檔之間的差異,合并消除差異。
同行評審(Review),使用Review board、Gerrit、CodeStriker、Code Review Tool等工具之一,由項(xiàng)目組或各級負(fù)責(zé)人員實(shí)施文檔檢查和評審。
缺陷跟蹤(Bug trace),使用JIRA、BugZilla、Bugtracker等工具之一,對發(fā)現(xiàn)的問題進(jìn)行跟蹤,直到問題解決。
自動構(gòu)建,將一個組織內(nèi)部的全部文檔每天自動構(gòu)建為目標(biāo)文檔,并收集分析構(gòu)建過程中發(fā)現(xiàn)的問題。
采用GitLab 服務(wù)系統(tǒng),用于文檔倉庫管理,使用Git作為文檔代碼管理工具,可一站式實(shí)現(xiàn)上述軟件工程工具功能。文檔在最后完成交付時(shí),需要統(tǒng)一潤色。
三、 軟件系統(tǒng)組成
MBT 文檔生成工具由圖形編輯界面程序和編譯處理程序兩部分組成。 一般情況下,用戶只需要使用DocEditor編輯器即可。高級用戶可使用編譯處理程序,實(shí)現(xiàn)一些自動化的文檔處理調(diào)用。
MBT文檔生成工具提供了易用的圖形編輯界面。
左邊是章節(jié)樹,點(diǎn)擊章節(jié)節(jié)點(diǎn),可以在編輯器中選中相應(yīng)的章節(jié),右鍵菜單中,可查找章節(jié),拷貝、粘貼、刪除章節(jié)。
支持常用文檔腳本的插入。支持常用文檔腳本的插入。
支持在 Windows資源管理器中,選中圖像文件、 Word文件、 mbt、 txt文件,拖放到窗口中。
用戶可選擇一個其它編輯工具,如 Editplus 4、 UltraEdit、 Visual Studio 2013、 Visual Code、 Sublime等,使用命令行指令生成,或者用 MBT文檔生成工具編輯器打開再生成,獲得輸出結(jié)果文檔。
MBT文檔生成工具提供了基本的文檔校對功能,能夠檢查文檔中的中文文字錯誤。還可提供聯(lián)機(jī)錯別字檢查、英中和中英翻譯功能。
軟件版本和功能模塊
四、常用文檔工具對比
當(dāng)前常用幾種文檔工具中, Word/WPS,是目前最主流的工具,功能強(qiáng),可讀性較好;文檔撰寫效率較低;文檔工程化管理困難。 Latex,一般用于發(fā)表國外高等級學(xué)術(shù)期刊,專業(yè)化程度高;可讀性較差;模板定制困難,難以轉(zhuǎn)換到各級機(jī)關(guān)定制格式的文檔。 Markdown,是目前互聯(lián)網(wǎng)上最流行的方法,可讀性較好,接近 MBT;但模板定制困難,難以轉(zhuǎn)換到各級機(jī)關(guān)定制格式的文檔。
MBT在借鑒 Markdown優(yōu)點(diǎn)的基礎(chǔ)上,針對實(shí)際工作需要,進(jìn)一步優(yōu)化指令,優(yōu)化方法論,開發(fā)輔助工具。幾種技術(shù)對比如下表。
|
|
可讀性 |
撰寫效率 |
模板定制 |
機(jī)關(guān)格式支持 |
文檔工程化 |
|
Word/WPS |
優(yōu) |
差 |
優(yōu) |
優(yōu) |
差 |
|
Latex |
差 |
差 |
良 |
差 |
良 |
|
Markdown |
優(yōu) |
良 |
良 |
差 |
優(yōu) |
|
MBT |
優(yōu) |
優(yōu) |
優(yōu) |
優(yōu) |
優(yōu) |
| 聯(lián)系人: | 余工 |
|---|---|
| 電話: | 13521660992 |
| Email: | anbsim@foxmail.com |
| 微信: | anbsim |