014軟件開發(fā)技術(shù)文檔管理規(guī)范(參考版)
2025-01-21 10:48本頁(yè)面
【正文】 ? 靈活性：各個(gè)不同軟件項(xiàng)目，其規(guī)模和復(fù)雜程度有著許多實(shí)際差別，不能一律看待。按不同的類型、不同層次的讀者，決定怎樣適應(yīng)他們的需要? 精確性：文檔的行文應(yīng)當(dāng)十分準(zhǔn)確，不能出現(xiàn)多義性的描述? 清晰性：文檔編寫應(yīng)力求簡(jiǎn)明，如有可能，配以適當(dāng)?shù)膱D表，以增強(qiáng)其清晰性。關(guān)于技術(shù)文檔的復(fù)制（拷貝和或打?。┕ぷ鳎仨氁勒丈鲜龅慕栝喼贫冗M(jìn)行。? 絕密（Top Confidential）：產(chǎn)品文檔。如須長(zhǎng)期使用，要保留復(fù)印件；? 普通（Normal）：只有本公司特定崗位的技術(shù)人員才可以使用的文檔。借閱制度如下：? 明文（General）：可以自由借閱，只要辦理一下借閱手續(xù)即可。對(duì)于配置測(cè)試中心特定技術(shù)文檔的借閱，必須擁有主管技術(shù)副總裁或技術(shù)總監(jiān)的簽名許可。對(duì)于部門內(nèi)部的技術(shù)文檔借閱，申請(qǐng)人必須擁有部門經(jīng)理的簽名許可。一種是在軟件開發(fā)部門內(nèi)部的技術(shù)文檔借閱。一般采用簿式登記，以便清晰可查。登記時(shí)的原則是：手續(xù)嚴(yán)密、格式清晰醒目、簡(jiǎn)化適用、登記項(xiàng)目完整詳盡。具體采用什么樣的特征可根據(jù)具體情況進(jìn)行適當(dāng)?shù)姆诸?。另外還可以根據(jù)其它特征來分類。 文檔的配置 與項(xiàng)目有關(guān)的管理文檔和技術(shù)文檔的管理最終統(tǒng)一歸口于軟件配置測(cè)試中心的配置管理組。一種是作者將完成的合乎規(guī)范的技術(shù)文檔主動(dòng)交配置測(cè)試中心關(guān)于本項(xiàng)目指定的配置測(cè)試工程師進(jìn)行配置管理。同時(shí)記錄打印人和定稿打印的日期。軟件開發(fā)技術(shù)文檔管理規(guī)范 第 9 頁(yè) 共 13 頁(yè)在對(duì)文檔進(jìn)行登記歸檔時(shí)也必須如實(shí)記錄作者。每本文檔在形成時(shí)，在封面就須寫清楚文檔的第一作者及其合作者。以便今后可就某個(gè)技術(shù)細(xì)節(jié)找到相應(yīng)的人（作者）進(jìn)行更進(jìn)一步的探討和學(xué)習(xí)。技術(shù)文檔也可以由作者本人手工書寫，交秘書來打字完成，但技術(shù)文檔的作者必須進(jìn)行校對(duì)工作。 文檔的制作任何軟件開發(fā)技術(shù)文檔的作者必須嚴(yán)格按照《軟件開發(fā)技術(shù)文檔管理規(guī)范》來制作。? 收集項(xiàng)目組的管理文檔和技術(shù)文檔? 執(zhí)行階段計(jì)劃書、配置、測(cè)試和評(píng)審，經(jīng)過評(píng)審/審查后，進(jìn)入配置管理。 配置測(cè)試組的職責(zé)：? 編寫配置測(cè)試評(píng)審計(jì)劃書，評(píng)審/審查通過后，進(jìn)入配置管理。? 編寫階段開發(fā)計(jì)劃書、技術(shù)文檔，經(jīng)過評(píng)審/審查后，向配置測(cè)試組提交，進(jìn)入配置管理。軟件開發(fā)技術(shù)文檔管理規(guī)范 第 8 頁(yè) 共 13 頁(yè)4. 文檔管理規(guī)范 文檔管理崗位職責(zé) 產(chǎn)生文檔的單位包括：開發(fā)部的項(xiàng)目組和配置測(cè)試中心的配置測(cè)試組。因此，如果在文檔的交流方面，因?yàn)槲臋n制作工具的使用差異造成工作上的不便，文檔制作者本人應(yīng)該設(shè)法解決。以上行距為單倍行距。如下圖所示，具體設(shè)置可復(fù)制本文作模塊。? 頁(yè)腳，在頁(yè)腳左部填入創(chuàng)智標(biāo)徽POWERISE，右部填入頁(yè)號(hào)。軟件開發(fā)技術(shù)文檔管理規(guī)范 第 7 頁(yè) 共 13 頁(yè) 版本更新說明 關(guān)鍵詞為：Revision 內(nèi)容劃分為：日期(Date)、理由(Reason)、更新者(Revisor)。 文檔組成格式 公司所有文檔（僅一頁(yè)的文件可按單頁(yè)文檔格式組織）由封面、目錄（Content Table)、版本更新說明書（Rivision)、文件內(nèi)容等組成，如圖所示軟件開發(fā)技術(shù)文檔管理規(guī)范 第 5 頁(yè) 共 13 頁(yè) 件件 件件件件 件件件件 件件件件件件件目錄圖1文檔組成檔式 封面 封面組成可劃分為：1. 文檔號(hào)：. 文檔系列號(hào) (文檔文件名)字體: Arial , 小四, 加粗例：. PRSPIDXX ()2. 項(xiàng)目名稱: 中文字體: 黑體, 三號(hào)字體, 加粗英文字體: Arial , 三號(hào)字體, 加粗例：創(chuàng)智文檔規(guī)范3. 文檔名稱: 中文字體：黑體, 一號(hào)字體, 加粗英文字體：Arial, 一號(hào)字體, 加粗例：工程技術(shù)項(xiàng)目文檔規(guī)范4. 密級(jí)：英文字體: Arial, 小四字體, 加粗劃分為五類，采用下列關(guān)鍵詞Top ConfidentialHigh ConfidentialConfidentialNormalGeneral? Top Confidential：絕密產(chǎn)品文檔? High Confidential：機(jī)密規(guī)范、指南? Confidential：秘密計(jì)劃、管理? Normal：普通工作崗位有關(guān)? General：明文可以在社會(huì)上廣為流傳例 : Normal軟件開發(fā)技術(shù)文檔管理規(guī)范 第 6 頁(yè) 共 13 頁(yè)5. 版本號(hào)：關(guān)鍵詞為 Version 用 Arial 字體, 大小為小四號(hào)例: Version 6. 完成日期：用Arial 字體, 大小為小四號(hào)例: .7. 作者：Written By……用 Arial 字體,大小為小四號(hào), 加粗例: Written By POWERISE8. 公司LOGO: 用 USABLack 字體,大小為四號(hào), 加粗。3) “XX”：文檔標(biāo)識(shí)號(hào)，參見《軟件開發(fā)配置管理規(guī)程》 。? 系統(tǒng)功能說明書3. 文檔編制格式規(guī)范 文檔編碼規(guī)則公司所有的技術(shù)文檔，都必須具有一個(gè)唯一的系列號(hào)，格式為：
教學(xué)教案相關(guān)推薦
鄂ICP備17016276號(hào)-1