關於GJB438A-97軟體設計文件的疑問

[摘要]本文記錄了對GJB438A-97《武器系統軟體開發文件》的軟體設計文件的一些疑問。

1引言

　　GJB438A-97《武器系統軟體開發文件》規定了軟體設計文件編制的格式、內容和要求。在工程實踐中執行該標準時，感到其中有些要求比較難於理解和實施。

GJB438A-97是與GJB2786-96《武器系統軟體開發》配套的標準。GJB2786-96的編制參照採用了DoD-STD-2167A。

　　查閱了DoD-STD-2167A中關於軟體設計文件的原文，發現GJB438A-97也源於DoD-STD-2167A，但與原文有些差異。下面簡要記錄關於軟體設計文件編這些差異和疑問。

2標識

　　GJB438A-97規定軟體設計文件的1.1節是“標識”。對該節的要求是：

　　“列出本文件的：

a.已批准的標識號；

b.標題；

c.縮略語；

d.本文件適用的系統和計算機軟體配置項(CSCI)，並標識派生該CSCI更高層的規格說明。”

　　上述要求使我們把“已批准的標識號”理解為軟體設計文件的標識號，把“縮略語”理解為軟體設計文件中使用的所有縮略語，從而把整個縮略語表都放在了1.1節中。

　　DoD-STD-2167A DID SDD中關於“標識”的原文是：

　　“This paragraph shall be numbered 1.1 and shall contain the approved identification number, title, and abbreviation, if applicable, of the CSCI and the system to which it this SDD applies. This paragraph shall identify the higher-level specification(s) containing the requirements from which the design of this CSCI was derived.

　　從原文中可看出：

a.“已批准的標識號”是指CSCI的標識號；

b.“縮略語”是指CSCI的名稱中用到的縮略語；

　　如果某個設計文件中的所有縮略語有多頁，放在1.1節中好象不太合適。

3CSC的概要設計說明

　　GJB438A-97關於CSC的概要設計說明有如下要求：

　　“各節應提供以下資訊：

a.標識由需求規格說明分配給CSC的需求。如果CSC是由下一級的一些CSC組成的，則可以引用下一級的CSC描述部分資訊或全部資訊；

b.利用執行控制流和資料流來描述CSC的概要設計。如果CSC是由下一級的一些CSC組成，應標識下一級各CSC之間的相互關係。另外，應在軟體需求規格說明規定中標識每個

c.描述CSC的設計需求和設計約束，如果CSC是由下一級的一些CSC組成，則可引用下一級CSC的部分資訊和全部資訊。”

　　對以上描述有如下疑問：

a.“標識由需求規格說明分配給CSC的需求”，需求規格說明還沒有涉及CSC，怎麼能對CSC分配需求？

b.“應在軟體需求規格說明文件中標識每個CSCI的內部介面”，這裡說的是設計文件，怎麼又對軟體需求規格說明文件提出了要求？

c.“內部介面應由CSC和它的下一級CSC定位”，“定位”的含義是什麼？

d.在“則可以引用下一級的CSC描述部分資訊或全部資訊”與“則可引用下一級的CSC的部分資訊和全部資訊”中，為何前一句用“或”，後一句用“和”？

　　DoD-STD-2167A DID SDD中與上述要求對應的原文是：

　　This subparagraph shall provide the following information:

a.Identify the requirements allocated to the CSC from the applicable requirements specification(s). If the CSC is composed of sub-level CSCs, some or all of this information may be referenced and provided by the sub-level CSC description.

b.Describe the preliminary design of the CSC in terms of execution control and data flow. If a CSC is composed of sublevel CSCs, this description shall identify each CSCI internal interface documented in the Software Requirements Specification, that is to be addressed by the CSC and its sub-level CSCs, as applicable. This information may be referenced rather than duplicated for each sub-level CSC.

c.Identify the derived design requirements for the CSC and any design constraints imposed on or by the CSC. If the CSC is composed of sub-level CSCs, some or all of this information may be referenced and provided by the sub-level CSC description.

　　根據原文，似乎要這樣理解：

a.根據適用的需求規格說明標識分配給該CSC的軟體需求。如果CSC由下一級的一些CSC組成，這部分內容可全部或部分地由下一級的CSC提供；

b.利用執行控制流和資料流來描述CSC的概要設計。如果CSC由下一級的一些CSC組成，應指明由該CSC及其下一級CSC處理的軟體需求規格說明中規定的CSCI內部介面。下一級CSC的描述可引用這些內容而不必複述；

c.標識對該CSC衍生的設計要求和設計約束，以及由該CSC提出的設計約束。如果CSC由下一級的一些CSC組成，這部分內容可全部或部分地由下一級的CSC提供。

4下一級CSC的概要設計說明

　　GJB438A-97對下一級CSC的概要設計說明有如下規定：

　　“從3.2.1.1節開始編號，標識下一級的CSC的名稱和專案唯一標識號及其用途，以及提供3.2.X中c項所需要的資訊。”

　　對以上描述有如下疑問：

　　3.2.X節要提供CSC的a、b、c三項資訊，為什麼對下一級CSC只要求提供c項資訊？

　　根據原文“provide the information required by a through c above”，上述描述似乎要改為“提供3.2.X中從a到c項所需要的資訊”。

5設計要求及約束

　　GJB438A-97規定軟體設計文件的第4.X.Y.1的標題是“（CSU的名稱）的設計及約束”，第4.X.Y.2的標題是“（CSU的名稱）的設計”。兩節的標題中都有設計。根據DoD-STD-2167A DID SDD的原文，第4.X.Y.1的標題似乎要改為“（CSU的名稱）的設計要求及約束”。

6程式語言和庫

　　GJB438A-97關於程式語言和庫有如下要求：

　　“如果CSU不是用CSCI規定語言編寫，那麼要標識這一程式語言，並且闡述使用該語言的基本原理。如果CSU儲存在庫中，則各節要標識庫的名稱和專案唯一的標識號以及描述該庫的設計文件。”

　　DoD-STD-2167A DID SDD中與上述要求對應的原文是：

　　“If the CSU is to be coded in a programming language other than the specified CSCI language, the programming language shall be identified and the rationale for its use shall be provided. If the CSU resides in a library, this subparagraph shall identify the library by name and project unique identifier, and the design document in which the library description can be found.”

　　根據原文，似乎要這樣理解：

　　“如果CSU的程式設計不使用為CSCI指定的程式語言，那麼應指明該程式語言，並且闡述使用該程式語言的理由。如果CSU是一個庫單元，則應在此指明庫的名稱和專案唯一的標識號以及可找到的描述該庫的設計文件。”

7邏輯流程

　　GJB438A-97關於邏輯流程的描述有如下要求：

　　“h. 邏輯流程圖。根據a到g項描述CSU的邏輯流程，並描述CSU執行時初始化的條件、呼叫的通訊介面的特徵以及其它CSU控制條件。若在CSCI的操作期間序列是被動態的控制，則應描述控制的方法和該方法的邏輯和輸入條件，例如時間變化、優先順序賦值、諸如輸入/輸出、內部儲存器資料傳送的內部操作、離散輸入訊號的讀出以及與CSCI的中斷操作的時間關係；”

　　對以上描述有如下疑問：

a.“邏輯流程圖”，從後面的要求中看不出一定要用“圖”來描述；

b.“其它CSU控制條件”為何要在這裡描述？

c.“優先順序賦值”是什麼含義？

d.“與CSCI的中斷操作的時間關係”是什麼含義？

　　DoD-STD-2167A DID SDD中與上述要求對應的原文是：

“Logic flow. Describe the logic flow of the CSU in terms of the above items. Describe the conditions under which CSU execution is initiated and, if applicable, communication interface features are invoked, and the conditions under which control is passed to other CSUs, as applicable. If sequencing is dynamically controlled during the CSCI's operations, the method for sequence control and the logic and input conditions of that method shall be describe, such as timing variations, priority assignments, internal operations such as data transfer in and out of internal memory, sensing of discrete input signals, and timing relationships between operations with the CSCI.”

　　根據原文，似乎要這樣理解：

　　“h. 邏輯流程。根據a到g項內容描述CSU的邏輯流程。要描述啟動CSU執行的條件、被啟用的通訊介面功能（如果有）、把控制傳給其它CSU的條件等。如果在CSCI的操作期間，執行順序是動態控制的，則應描述順序控制的方法以及該方法的邏輯和輸入條件，如定時變更、優先順序分配、諸如內部儲存器的資料移入移出那樣的內部操作、離散輸入訊號的判讀以及CSCI各種操作之間的定時關係。”

8CSCI資料

　　GJB438A-97關於CSCI資料的描述有如下要求：

　　“為便於可讀和易維護，可用一個或幾個表提供如下資訊，這些資訊可提供給所有的資料元素。”

　　最後一句“這些資訊可提供給所有的資料元素”令人費解。根據原文：

　　“For ease in readability and maintenance, the information required below be provided in one or more tables. The following information shall be provided for each data element, as applicable；”

　　原來最後一句的意思是“對每一個數據元素都要按以下適用的專案來描述：”

　　GJB438A-97關於CSCI內部資料有如下描述：

　　“（12）資料元素的CSU的專案唯一標識號；”

　　對照原文“The CSU project unique identifier(s) where the data element is used”，似乎要理解為“使用該資料元素的CSU的專案唯一標識號；”

9資料檔案與CSC/CSU的交叉索引

　　GJB438A-97規定軟體設計文件第6.1節的標題是“CSC/CSU資料檔案的交叉引用”。根據原文“Data file to CSC/CSU cross reference”，似乎要理解為“資料檔案與CSC/CSU的交叉索引”。

10需求可追蹤性

　　GJB438A-97關於需求可追蹤性有如下要求：

　　“應提供分配給每個CSC的上一級CSU，可追溯到軟體需求規格說明和介面需求規格說明要求的需求。”

　　“每個CSC的上一級CSU”顯然是不成立的。

　　DoD-STD-2167A DID SDD中對應的原文是：

　　“This section shall be numbered 7 and shall provide traceability of the requirements allocated down to the CSU level of each CSC back to the requirements of the Software Requirements Specification and Interface Requirements Specification.”

　　這似乎要理解為：

“本章應描述每個CSC中，一直到CSU這一級與軟體需求規格說明和介面需求規格說明相互之間的可追蹤性。”

後記

本文素材記於2002年。GJB438A-97現在仍然是有關專案必須遵循的標準之一。

2009年5月31日