專利名稱：Do-178b標(biāo)準(zhǔn)文檔生成器的制作方法
技術(shù)領(lǐng)域：
本發(fā)明可以自動(dòng)生成滿足D0-178B標(biāo)準(zhǔn)的航空機(jī)載軟件研制過程中需要編寫的 多類文檔，屬于軟件工程自動(dòng)化工具領(lǐng)域。
背景技術(shù)：
D0-178B是由RTCA和EUR0CAE制定并頒布的國際民用航空機(jī)載軟件研制和審查 的標(biāo)準(zhǔn)。國際上所有民用航空機(jī)載軟件的研制都需要滿足D0-178B標(biāo)準(zhǔn)。與此同時(shí)，現(xiàn)在 國際上許多軍用航空機(jī)載軟件也是按照D0-178B標(biāo)準(zhǔn)來研制和審查的，如歐洲的A400M，EC 225，美國的C-130J，C-17，以及我國的XXX工程(涉密，不提供名稱)等等。依據(jù)D0-178B標(biāo)準(zhǔn)，在軟件研制過程中需要編寫大量的文檔，而且這些文檔之間 有大量的內(nèi)容是需要通過協(xié)調(diào)并維護(hù)其一致性的，這需要化費(fèi)大量的人力和精力。尤其是 軟件計(jì)劃過程中需要編寫的《軟件開發(fā)計(jì)劃》、《軟件驗(yàn)證計(jì)劃》、《軟件配置管理計(jì)劃》、《軟 件質(zhì)量保證計(jì)劃》、《軟件審查計(jì)劃》、《軟件需求標(biāo)準(zhǔn)》、《軟件設(shè)計(jì)標(biāo)準(zhǔn)》、《軟件編碼標(biāo)準(zhǔn)》以 及最終軟件審查以前需要編寫的《軟件完成綜述》等文檔，研制單位在編寫過程會(huì)有如下問 題問題一、這些文檔有許多重復(fù)的內(nèi)容，例如，在《軟件審查計(jì)劃》和《軟件完成綜述》 中都需要給出系統(tǒng)概述、軟件概述、軟件級(jí)別等內(nèi)容，而在《軟件審查計(jì)劃》、《軟件開發(fā)計(jì) 劃》、《軟件驗(yàn)證計(jì)劃》和《軟件完成綜述》中都會(huì)涉及到軟件生命周期的定義。這些同樣的 內(nèi)容出現(xiàn)在多個(gè)不同的文檔，但這些內(nèi)容在文檔編制過程又天天在更改，很難維持這些內(nèi) 容在各個(gè)文檔中的一致性。問題二、除了上述重復(fù)的內(nèi)容以外，不同文件之間的許多內(nèi)容是密切關(guān)聯(lián)的。例 如，在《軟件開發(fā)計(jì)劃》中給出了軟件開發(fā)的活動(dòng)和方法，而《軟件驗(yàn)證計(jì)劃》中給出了軟件 驗(yàn)證的活動(dòng)和方法。這時(shí)要求軟件驗(yàn)證活動(dòng)和方法依賴于軟件開發(fā)活動(dòng)和方法，二者必須 是配套的、互相一致、水乳交融的。問題三、由于上面二個(gè)原因，編寫各個(gè)文檔的軟件開發(fā)人員、軟件驗(yàn)證人員、軟件 配置管理人員、軟件質(zhì)量保證人員之間需要大量的協(xié)調(diào)和信息更新活動(dòng)。任何一個(gè)人都要 能隨時(shí)看到其它人員編寫的文檔的最新內(nèi)容，例如，驗(yàn)證人員在編寫《軟件驗(yàn)證計(jì)劃》應(yīng)該 能即時(shí)地看到開發(fā)人員在《軟件開發(fā)計(jì)劃》中更改的內(nèi)容，這對(duì)于保證二個(gè)計(jì)劃的一致性， 減少返工是至關(guān)重要的。雖然可以通過版本管理的工具來實(shí)現(xiàn)一定程度上的信息更新，但 這樣的信息更新不是即時(shí)的，導(dǎo)致協(xié)調(diào)工作的困難。問題四、在傳統(tǒng)的文檔編寫過程中，還有一個(gè)嚴(yán)重的問題是，多個(gè)人需要同時(shí)修改 同一個(gè)文件，這樣就導(dǎo)致了并行文檔編寫與文件沖突合并之間的矛盾。例如，有五個(gè)軟件開 發(fā)人員在同時(shí)編寫或修改《軟件開發(fā)計(jì)劃》，怎樣把每個(gè)人所做的修改很好地合并起來而不 發(fā)生沖突，這是個(gè)難題。常見的版本管理工具只能解決其中的一個(gè)問題，要么實(shí)現(xiàn)一定程度 的文檔并行編寫，但這樣會(huì)導(dǎo)致大量的文檔沖突；要么利用互斥機(jī)制來防止文檔沖突，但這 樣又不能實(shí)現(xiàn)多個(gè)人員的并行編寫文檔，降低了效率。
3
問題五、D0-178B標(biāo)準(zhǔn)對(duì)這些文檔的內(nèi)容提出了嚴(yán)格的要求，軟件研制單位在編 寫這一系列的文檔過程中常常出現(xiàn)顧此失彼的現(xiàn)象，遺漏若干內(nèi)容從而達(dá)不到D0-178B要 求。問題六、還有一個(gè)耗費(fèi)時(shí)間非常巨大的“苦力活”，也就是調(diào)整各個(gè)文檔的統(tǒng)一格 式。我國軍用航空機(jī)載軟件的研制對(duì)每個(gè)文件都有嚴(yán)格的格式要求。雖然使用統(tǒng)一的Word 和Excel模板會(huì)減輕一定的工作量，但文檔內(nèi)容的拷貝粘貼，不同Word和Excel版本帶來 的格式差異，往往讓人苦不堪言。問題七、一個(gè)比問題六更令人頭痛的問題，請(qǐng)考慮如下情況某單位為項(xiàng)目X1按照 格式要求G1完成的一套文檔的編寫，并已經(jīng)得到了相關(guān)單位的審查和認(rèn)可?，F(xiàn)在要做另外 一個(gè)項(xiàng)目X2，而這個(gè)項(xiàng)目要求使用格式G2,為了重用一部分項(xiàng)目X1中文檔的若干內(nèi)容，拷貝 過來以后還要重做一次繁瑣而又沒有生產(chǎn)力的格式調(diào)整工作。問題八、幾乎每一個(gè)文檔都有大量的參考文獻(xiàn)，術(shù)語表等內(nèi)容，并且文檔之間存在 大量的引用。每一個(gè)引用文檔都需要列出其文檔編號(hào)、文檔名稱、文檔版本、文檔作者、發(fā)布 日期等內(nèi)容，并保證這些數(shù)據(jù)的正確性。這需要大量的維護(hù)工作，而且一旦基線發(fā)生變更 (如由于評(píng)審、審查等引起的變更)，這些數(shù)據(jù)需要重新檢查和維護(hù)。以上列舉的種種問題，使得機(jī)載軟件研制單位在軟件研制之初，就需要化費(fèi)大量 的時(shí)間、克服大量的困難來編寫這些文檔。本發(fā)明致力于從根本上解決上述各項(xiàng)問題。

發(fā)明內(nèi)容
本發(fā)明針對(duì)以上問題，提出了一個(gè)滿足D0-178B標(biāo)準(zhǔn)的文檔生成器。它可以生成 文檔包括但不限于《軟件開發(fā)計(jì)劃》、《軟件驗(yàn)證計(jì)劃》、《軟件配置管理計(jì)劃》、《軟件質(zhì)量保 證計(jì)劃》、《軟件審查計(jì)劃》、《軟件需求標(biāo)準(zhǔn)》、《軟件設(shè)計(jì)標(biāo)準(zhǔn)》、《軟件編碼標(biāo)準(zhǔn)》、《軟件完成 綜述》等。具體地，本發(fā)明主要包含四部分的內(nèi)容發(fā)明一、本發(fā)明通過充分研究D0-178B標(biāo)準(zhǔn)對(duì)這些文檔的內(nèi)容的要求，根據(jù)長期 以來編寫這些文檔所積累的經(jīng)驗(yàn)，把這些文檔的內(nèi)容分解成一個(gè)個(gè)獨(dú)立的數(shù)據(jù)項(xiàng)，并通過 有效的方式把這些數(shù)據(jù)項(xiàng)組織起來，不同的人員編寫不同的數(shù)據(jù)項(xiàng)。通過這一點(diǎn)發(fā)明，可以解決如下問題 通過數(shù)據(jù)項(xiàng)的分解和組織，有效地避免了各個(gè)文檔的內(nèi)容的冗余，對(duì)重復(fù)的內(nèi) 容保證了文檔內(nèi)容的一致性(上述問題一)。 由于數(shù)據(jù)項(xiàng)的分解和組織是由D0-178B的權(quán)威專家來完成的，這保證了數(shù)據(jù)項(xiàng) 的完整性，從根本上避免了內(nèi)容遺漏的現(xiàn)象(上述問題五)。發(fā)明二、把組織好的數(shù)據(jù)項(xiàng)通過TOB訪問的方式，來進(jìn)行文檔的編寫、修改和查 詢。通過這一點(diǎn)發(fā)明，可以解決如下問題 通過TOB訪問的方式對(duì)這些數(shù)據(jù)項(xiàng)進(jìn)行編寫和修改，有效地實(shí)現(xiàn)了文檔編寫人 員的并行工作，并從根本上解決了文檔編寫沖突的問題，既實(shí)現(xiàn)了并行文檔編寫，也避免了 文件沖突(上述問題四)。 通過WEB訪問的方式，還實(shí)現(xiàn)了文檔信息的即時(shí)更新(上述問題三)，任何文檔
4編寫的人員都可以看到一秒鐘以前其它文檔編寫人員所做的編寫或修改活動(dòng)。 通過即時(shí)的信息更新，WEB訪問的方式可以更好地保證各文檔之間相關(guān)內(nèi)容的 一致性(上述問題二)。發(fā)明三、自動(dòng)生成滿足D0-178標(biāo)準(zhǔn)，并符合軍方規(guī)定格式的文檔。通過這一點(diǎn)發(fā) 明，可以解決如下問題 由于文檔是自動(dòng)生成的，所以它能保證滿足軍方對(duì)文檔格式的要求(上述問題 六)，不會(huì)出現(xiàn)絲毫的差錯(cuò)，節(jié)約了大量的時(shí)間； 結(jié)合上述對(duì)數(shù)據(jù)項(xiàng)的分解和組織，通過自動(dòng)生成文檔，不會(huì)在任何文檔里遺漏 D0-178B標(biāo)準(zhǔn)所要求的任何內(nèi)容，更好地保證了生成的文檔能符合D0-178B標(biāo)準(zhǔn)的要求(上 述問題五)。 每次自動(dòng)生成文檔的時(shí)候，可以自動(dòng)地維護(hù)每個(gè)文檔的編號(hào)、名稱、版本、發(fā)布 日期等內(nèi)容，并在被引用的地方自動(dòng)插入正確的引用信息(上述問題八)發(fā)明四、文檔的生成不是使用硬代碼的，而是根據(jù)給定的模板來生成的。該文檔生 成器可以使用不同的模板庫。通過這一點(diǎn)，可以解決如下問題 在文檔生成的時(shí)候，只需要選用模板庫中的另外一套模板，就可以使用相同的 內(nèi)容生成不同格式的文檔，以滿足不同項(xiàng)目的要求(上述問題七)。綜合上述四條發(fā)明內(nèi)容，本發(fā)明的意義在于徹底地解決了背景技術(shù)中列出的文檔 編寫過程的各個(gè)問題，能夠保持編寫內(nèi)容的實(shí)時(shí)更新、保證不同文檔內(nèi)容的一致性、保證了 各文檔內(nèi)容的完整性、實(shí)現(xiàn)了大規(guī)模團(tuán)隊(duì)進(jìn)行文檔編寫的并發(fā)、避免了文檔的沖突、并能保 證滿足不同格式的要求、減少文檔編寫的工作量、提高文檔編寫的效率、節(jié)約文檔編寫的時(shí) 間。


附圖中，圖1，D0_178B文檔生成器結(jié)構(gòu)圖，給出了本發(fā)明的簡(jiǎn)易工作流程圖，圖2， 基于WEB的文檔編寫、修改和查詢，給出了多個(gè)人員并行工作編寫文檔的示意圖。
具體實(shí)施例方式下面按照發(fā)明的四點(diǎn)內(nèi)容分別介紹該發(fā)明的實(shí)施方式。發(fā)明一、數(shù)據(jù)的分解和組織數(shù)據(jù)的分解要恰到好處，既不能顆粒太粗，導(dǎo)致數(shù)據(jù)的冗余(有數(shù)據(jù)的冗余就可 能會(huì)產(chǎn)生不一致的現(xiàn)象)；又不能顆粒太細(xì)，導(dǎo)致數(shù)據(jù)項(xiàng)管理的不便。為方便起見，我們假設(shè)共有η個(gè)文檔需要生成，這η個(gè)文檔的原子數(shù)據(jù)項(xiàng)集合分別 記為X1, X2,…χη。數(shù)據(jù)項(xiàng)分解的具體算法如下第一步任取二個(gè)集合，記為Y和Z第二步如果Y η ζ乒Φ，那么去掉Y和ζ，加入γ η ζ，γ-ζ, ζ-γ第三步重復(fù)第一步和第二步，直到對(duì)于任何Y興Ζ，都有Y η Z = φ例假設(shè)要生成三個(gè)文檔，它們的原子數(shù)據(jù)項(xiàng)分別為{1,2,3,4,5,6}, {1,3,7}, {4,5,3,8}對(duì)第一、第二個(gè)集合進(jìn)行操作，得到{1,3}, {2,4,5,6}, {7}，{4,5,3,8}
對(duì)第一、第四個(gè)集合進(jìn)行操作，得到{3}，{1}，{4,5,8}, {2,4,5,6}, {7}對(duì)第三、第四個(gè)集合進(jìn)行操作，得到{4,5}, {8}，{2,6}, {3}，{1}，{7}至此，對(duì)于任意的一組集合Y興Z，都有Y Π Z = Φ，算法結(jié)束，{4，5}，{8}, {2,6} {3}，{1}，{7}就是我們分解后的數(shù)據(jù)項(xiàng)。這樣，既確保了數(shù)據(jù)項(xiàng)不會(huì)有冗余，也使得數(shù)據(jù)項(xiàng) 具有足夠粗的顆粒以方便管理。經(jīng)過分解和組織后，每個(gè)數(shù)據(jù)項(xiàng)都會(huì)分配唯一的數(shù)據(jù)項(xiàng)標(biāo)識(shí)。發(fā)明二、基于TOB的數(shù)據(jù)項(xiàng)編寫、修改與查詢基于WEB的B/S架構(gòu)的軟件已經(jīng)越來越普遍。在本發(fā)明中，我們不僅采用了基于 WEB頁面方式的進(jìn)行數(shù)據(jù)項(xiàng)編寫、修改與查詢，還實(shí)現(xiàn)了如下功能任務(wù)分配組織了編寫文檔的團(tuán)隊(duì)(軟件開發(fā)人員、軟件驗(yàn)證人員、軟件配置管理 人員、軟件質(zhì)量保證人員、項(xiàng)目經(jīng)理、型號(hào)總師等)后，我們可以通過一個(gè)任務(wù)管理子系統(tǒng) 把分解和組織后的數(shù)據(jù)項(xiàng)分配給合適的人員去編寫。由于這些數(shù)據(jù)項(xiàng)經(jīng)過了良好的分解和 組織，保證了在任務(wù)分配的時(shí)候不會(huì)出現(xiàn)數(shù)據(jù)沖突，而且通過基于WEB的文檔編寫和修改 實(shí)現(xiàn)了并發(fā)工作。數(shù)據(jù)項(xiàng)控制當(dāng)某個(gè)編寫文檔的人員登錄系統(tǒng)后，文檔生成系統(tǒng)會(huì)給他顯示一個(gè) 樹狀結(jié)構(gòu)的數(shù)據(jù)項(xiàng)組織圖。點(diǎn)擊一個(gè)數(shù)據(jù)項(xiàng)，如果這個(gè)數(shù)據(jù)項(xiàng)是分配給他編寫的，他可以做 編寫、修改和提交，如果該數(shù)據(jù)項(xiàng)不是分配給他編寫的，他可以查詢到別人編寫的該數(shù)據(jù)項(xiàng) 的最新信息，從而實(shí)現(xiàn)了即時(shí)的信息更新。圖2給出了多個(gè)人并行編寫文檔的示意圖。發(fā)明三、文檔生成文檔生成器生成文檔的過程分成如下二個(gè)步驟第一步，數(shù)據(jù)準(zhǔn)備。例如，對(duì)每個(gè)要生成的文檔給出一個(gè)新的版本號(hào)，記錄這次文 檔生成的日期，自動(dòng)更新文檔的相關(guān)屬性，生成一個(gè)統(tǒng)一的文檔引用信息庫。第二步，文檔生成。對(duì)每個(gè)要生成的文檔取出其模板，對(duì)于模板中使用的數(shù)據(jù)項(xiàng)， 從數(shù)據(jù)庫中查詢數(shù)據(jù)，并插入到文檔中相應(yīng)的位置。數(shù)據(jù)項(xiàng)是根據(jù)其標(biāo)識(shí)來查詢的。發(fā)明四、模板的定義和定制為了方便模板中數(shù)據(jù)項(xiàng)的替換，并且在替換過程中保留模板的格式，我們采用RTF 文件做模板。RTF文檔可以很方便的轉(zhuǎn)換成HTML或PDF文件。模板的定義也是基于TOB頁面的，在TOB頁面內(nèi)嵌入了 RTF文檔的編輯器。使用 該編輯器定制文檔的格式。在該WEB頁面中也顯示了經(jīng)過分解和組織后的數(shù)據(jù)項(xiàng)的樹狀結(jié)構(gòu)。當(dāng)模板中需要 用到某數(shù)據(jù)項(xiàng)時(shí)，可以直接把該數(shù)據(jù)項(xiàng)拖入到RTF文檔編輯器內(nèi)。拖入后的數(shù)據(jù)項(xiàng)會(huì)自動(dòng) 變成一段包含數(shù)據(jù)項(xiàng)標(biāo)識(shí)的宏代碼。在文檔生成的時(shí)候，一旦識(shí)別到這樣的宏代碼，就會(huì)從 數(shù)據(jù)庫查詢相應(yīng)的數(shù)據(jù)項(xiàng)，插入到相應(yīng)的位置，并保持其原有的格式。
權(quán)利要求
把DO 178B標(biāo)準(zhǔn)要求編寫的《軟件開發(fā)計(jì)劃》、《軟件驗(yàn)證計(jì)劃》、《軟件配置管理計(jì)劃》、《軟件質(zhì)量保證計(jì)劃》、《軟件審查計(jì)劃》、《軟件需求標(biāo)準(zhǔn)》、《軟件設(shè)計(jì)標(biāo)準(zhǔn)》、《軟件編碼標(biāo)準(zhǔn)》、《軟件完成綜述》等文檔進(jìn)行數(shù)據(jù)項(xiàng)的分解和組織，有效地消除數(shù)據(jù)冗余，保證數(shù)據(jù)的一致性和完整性。
2.把分解和組織好的數(shù)據(jù)項(xiàng)通過WEB訪問的方式進(jìn)行文檔的編寫、修改和查詢，保證 文檔編寫的并行工作、消除數(shù)據(jù)沖突現(xiàn)象、實(shí)現(xiàn)的文檔信息的實(shí)時(shí)更新。
3.通過數(shù)據(jù)庫查詢獲得內(nèi)容，通過模板獲得格式，二者結(jié)合生成帶有指定格式和指定 內(nèi)容的文件。
4.使用RTF文件作為文檔模板，在WEB頁面中嵌入的RTF編輯器定義格式，在經(jīng)過分解 和組織后的數(shù)據(jù)項(xiàng)的樹狀列表中用鼠標(biāo)拖曳的方法插入數(shù)據(jù)項(xiàng)。
全文摘要
DO-178B文檔生成器屬于軟件工程自動(dòng)化領(lǐng)域，其特征在于對(duì)多個(gè)文檔的數(shù)據(jù)項(xiàng)進(jìn)行分解和組織，以WEB頁面的方式實(shí)現(xiàn)對(duì)這些文檔的編寫、修改和查詢，并自動(dòng)地從數(shù)據(jù)庫查詢數(shù)據(jù)項(xiàng)內(nèi)容、從模板庫取出文檔格式、生成各類文檔。該發(fā)明可以從根本上解決原來文檔編寫中的多重困難，能夠?qū)崿F(xiàn)文檔內(nèi)容的即時(shí)更新、保證不同文檔內(nèi)容的一致性、確保各文檔內(nèi)容的完整性、實(shí)現(xiàn)了大規(guī)模團(tuán)隊(duì)進(jìn)行文檔編寫的并發(fā)工作、避免了文檔的沖突、并能滿足軍方不同格式的要求、減少文檔編寫的工作量、提高文檔編寫的效率、節(jié)約文檔編寫的時(shí)間。
文檔編號(hào)G06F9/44GK101923464SQ201010176539
公開日2010年12月22日 申請(qǐng)日期2010年5月19日 優(yōu)先權(quán)日2010年5月19日
發(fā)明者王云明 申請(qǐng)人:上海愛韋訊信息技術(shù)有限公司