軟件開(kāi)發(fā)和文檔編制管理

QG湖南計(jì)算機(jī)股份有限公司管理標(biāo)準(zhǔn)軟件開(kāi)發(fā)和文檔編制管理程序2005-03-25發(fā)布2005-03-28實(shí)施湖南計(jì)算機(jī)股份有限公司發(fā)布湖南計(jì)算機(jī)股份有限公司管理標(biāo)準(zhǔn)湖南計(jì)算機(jī)股份有限公司管理標(biāo)準(zhǔn)軟件開(kāi)發(fā)和文檔編制程序QG/PLA07.02—2002l范圍

本標(biāo)準(zhǔn)規(guī)定了軟件產(chǎn)品開(kāi)發(fā)研制過(guò)程質(zhì)量職責(zé)及控制要求。2引用標(biāo)準(zhǔn)GB8567—88計(jì)算機(jī)軟件產(chǎn)品開(kāi)發(fā)文件編制指南3定義不需用。4職責(zé)4.1設(shè)計(jì)部門負(fù)責(zé)人批準(zhǔn)軟件開(kāi)發(fā)項(xiàng)目任務(wù)書。4.2技術(shù)發(fā)展部負(fù)責(zé)組織對(duì)公司下達(dá)的軟件項(xiàng)目進(jìn)行各階段的評(píng)審。4.3物流部經(jīng)理負(fù)責(zé)組織項(xiàng)目的最終檢測(cè)。4.4項(xiàng)目負(fù)責(zé)人負(fù)責(zé)組織對(duì)軟件項(xiàng)目的各階段進(jìn)行考核、質(zhì)量控制、組織接口協(xié)調(diào)文檔的發(fā)布批準(zhǔn)及文檔更改審批。4.5項(xiàng)目負(fù)責(zé)人(軟件負(fù)責(zé)人)負(fù)責(zé)：a、制定軟件課題開(kāi)發(fā)計(jì)劃和進(jìn)度安排及資源需求；b、進(jìn)行總體設(shè)計(jì)；

c、提供階段評(píng)審資料；

d、協(xié)調(diào)技術(shù)接口。4.6標(biāo)準(zhǔn)檔案室管理員負(fù)責(zé)文檔的存貯、保管和處理。5工作程序與要求5.1公司下達(dá)的軟件項(xiàng)目立項(xiàng)后，由技術(shù)發(fā)展部下達(dá)[新產(chǎn)品研制任務(wù)書]。5.2軟件項(xiàng)目5.2.1公司立項(xiàng)項(xiàng)目由技術(shù)發(fā)展部負(fù)責(zé)組織評(píng)審。a、項(xiàng)目負(fù)責(zé)人（軟件負(fù)責(zé)人）于評(píng)審前3天填寫[評(píng)審申請(qǐng)表]，并備齊評(píng)審資料，交技術(shù)發(fā)展部。b、技術(shù)發(fā)展部審批評(píng)審申請(qǐng)表，并將有關(guān)資料提前3-5天下發(fā)評(píng)審組成員以供分工審閱，c、評(píng)審組長(zhǎng)主持評(píng)審會(huì)，并填寫[評(píng)審報(bào)告]；評(píng)審結(jié)束，技術(shù)發(fā)展部負(fù)責(zé)收回評(píng)審資料交項(xiàng)目組存檔。5.2.2凡上級(jí)下達(dá)的項(xiàng)目，若上級(jí)部門（或系統(tǒng)組織單位）對(duì)評(píng)審另有要求時(shí)，則按其執(zhí)行；否則，按5.2.1條執(zhí)行。5.2.4若項(xiàng)目既有軟件開(kāi)發(fā)，又有硬件開(kāi)發(fā)，其評(píng)審是分開(kāi)（軟件、硬件）還是合并進(jìn)行，由設(shè)計(jì)部門負(fù)責(zé)人決定。5.3軟件項(xiàng)目的檢測(cè)5.3.1項(xiàng)目負(fù)責(zé)人負(fù)責(zé)組織完成下述工作。a、測(cè)試階段的檢測(cè)；b、軟件課題的系統(tǒng)檢測(cè)；c、軟件版本存檔前的檢測(cè)。對(duì)以上測(cè)試發(fā)現(xiàn)的問(wèn)題，由項(xiàng)目組填寫[軟件測(cè)試修改單]，經(jīng)分析原因和采取糾正措施及回歸測(cè)試后，由項(xiàng)目負(fù)責(zé)人審批，方可列入正式版本。5.3.2物流部經(jīng)理負(fù)責(zé)組織軟件版本存檔前的最終檢測(cè)，并在[版本送檢（啟用）通知單]上簽署檢測(cè)結(jié)果。5.4設(shè)計(jì)部門負(fù)責(zé)人批準(zhǔn)軟件項(xiàng)目開(kāi)發(fā)計(jì)劃。5.5設(shè)計(jì)部門負(fù)責(zé)人審批各項(xiàng)目負(fù)責(zé)人資格，并負(fù)責(zé)：a、考核各階段的進(jìn)度完成情況；b、及時(shí)協(xié)調(diào)開(kāi)發(fā)中組織接口及計(jì)劃修改；

c、控制項(xiàng)目開(kāi)發(fā)各階段的設(shè)計(jì)輸入、設(shè)計(jì)輸出、技術(shù)狀態(tài)和各階段的驗(yàn)證,并對(duì)軟件的正確性、文檔的完整性負(fù)責(zé)。5.6項(xiàng)目負(fù)責(zé)人(軟件負(fù)責(zé)人)負(fù)責(zé)組織：a、制定項(xiàng)目開(kāi)發(fā)計(jì)劃，若軟件、硬件相結(jié)合的，其計(jì)劃也可合并制定。開(kāi)發(fā)計(jì)劃須明確劃分各開(kāi)發(fā)階段，并可按開(kāi)發(fā)階段進(jìn)行自主開(kāi)發(fā)；b、總體設(shè)計(jì)；d、組織軟件(版本)檢測(cè)，并對(duì)檢測(cè)結(jié)果負(fù)責(zé)；e、協(xié)調(diào)技術(shù)接口；f、定期填報(bào)工作進(jìn)度，若進(jìn)度計(jì)劃需修改，應(yīng)在報(bào)表中申述（進(jìn)度報(bào)表既可按月也可按項(xiàng)目分階段填報(bào)）。5.7軟件的交付管理按[版本啟用/存檔細(xì)則]執(zhí)行。5.8軟件版本管理5.8.1應(yīng)顧客需要進(jìn)行軟件版本升級(jí)或修訂時(shí)，設(shè)計(jì)部門負(fù)責(zé)人確定項(xiàng)目負(fù)責(zé)人，組織軟件人員實(shí)施。5.8.2軟件負(fù)責(zé)人發(fā)出[版本送檢（啟用）通知單]升級(jí)的版本由物流部組織檢測(cè)合格后，由軟件負(fù)責(zé)人將新版本存入標(biāo)準(zhǔn)檔案室；并在[版本檔案]中詳細(xì)記錄升級(jí)內(nèi)容，存入項(xiàng)目檔案中。5.8.3技術(shù)人員在為顧客服務(wù)的現(xiàn)場(chǎng)，遇到需要版本修訂時(shí)，應(yīng)先電告項(xiàng)目負(fù)責(zé)人，經(jīng)認(rèn)可后，回廠填寫[用戶服務(wù)檔案]，必要時(shí)項(xiàng)目負(fù)責(zé)人應(yīng)組織評(píng)審和檢測(cè)。5.9文檔要求5.9.1各階段需具備的基本文檔及文檔格式（見(jiàn)附錄）

5.9.2鑒定需具備的文檔參見(jiàn)附錄。

6支持文件

7記錄

7.1質(zhì)量記錄

7.1.1JL/PLA10.05-2002版本啟用通知單7.1.2JL/PLA14.00-2002用戶服務(wù)檔案7.1.3JL/PLA07.06-2002軟件測(cè)試修改單以上記錄由標(biāo)準(zhǔn)檔案室保存三年。7.2工作記錄7.2.3版本檔案以上記錄由標(biāo)準(zhǔn)檔案室保存三年。7.3附錄附錄一：軟件產(chǎn)品文件表附錄二：版本啟用/存檔實(shí)施細(xì)則附錄三：概要設(shè)計(jì)說(shuō)明書附錄四：需求說(shuō)明書附錄五：軟件開(kāi)發(fā)規(guī)范附錄六：程序設(shè)計(jì)若干規(guī)定附錄一：軟件產(chǎn)品文件表序號(hào)文件名稱文件簡(jiǎn)號(hào)產(chǎn)品產(chǎn)品的組成部門成套軟件整件整件軟件1任務(wù)委托書RW●○2可行性研究報(bào)告KY●○3軟件需求說(shuō)明RX●○○○4數(shù)據(jù)要求說(shuō)明書SY○○○5項(xiàng)目開(kāi)發(fā)計(jì)劃XK○6概要設(shè)計(jì)說(shuō)明書GS○○○7詳細(xì)設(shè)計(jì)說(shuō)明書QS○○○8數(shù)據(jù)庫(kù)設(shè)計(jì)說(shuō)明書SG○○○9測(cè)試計(jì)劃CJ○○○10程序CX●●●11測(cè)試分析報(bào)告CF○○12用戶手冊(cè)YS●○○13操作手冊(cè)CS●○○14程序維護(hù)手冊(cè)CW○○○15項(xiàng)目開(kāi)發(fā)總結(jié)報(bào)告XZ●●16使用報(bào)告SB●●17產(chǎn)品標(biāo)準(zhǔn)—●●18媒體內(nèi)程序/數(shù)據(jù)目錄MM●●●19成套軟件明細(xì)表MX●20整件明細(xì)表MX●●21成套運(yùn)用文件清單YQ●○22整件匯總表ZH○○23鑒定報(bào)告JB●●24用戶反饋信息YX○○25維護(hù)記錄文件WJ○○26版本更新通知BT○○注：●表示必須編制的文件；○表示可根據(jù)產(chǎn)品的需要制定。湖南計(jì)算機(jī)股份有限公司用戶服務(wù)檔案JL/PLA14.00-2002出差人出差時(shí)間出差地點(diǎn)用戶名稱產(chǎn)品名稱版本號(hào)實(shí)際費(fèi)用（元）使用的系統(tǒng)環(huán)境：發(fā)現(xiàn)的問(wèn)題：解決情況：改動(dòng)的程序模塊：用戶意見(jiàn)：辦事處意見(jiàn)：處理結(jié)果（回廠后經(jīng)協(xié)調(diào)或評(píng)審結(jié)論）：湖南計(jì)算機(jī)股份有限公司版本檔案（工作記錄）編號(hào)：產(chǎn)品名稱版本號(hào)版本適用范圍源版本取代版本號(hào)版本源程序壓縮文件名代碼和提交人提交時(shí)間存檔日期配備的輸入方法：修改記錄：備注：軟件測(cè)試修改單JL/PLA07.06-2002軟件名稱測(cè)試人日期測(cè)試問(wèn)題：測(cè)試人：日期：原因分析：簽字：日期：糾正措施：簽字：日期：回歸測(cè)試：簽字：日期：審批意見(jiàn)：批準(zhǔn)人：日期：附錄二：版本啟用/存檔實(shí)施細(xì)則為了規(guī)范版本的管理，減少版本的數(shù)量，文檔資料的管理和保存，文檔的及時(shí)更新，以及便于電子化的管理和規(guī)范工作流程，特制定該實(shí)施細(xì)則。一、工作流程和任務(wù):說(shuō)明：內(nèi)部測(cè)試：進(jìn)行白盒測(cè)試，要求對(duì)源程序進(jìn)行檢查，分析出可能影響的模塊，并對(duì)相應(yīng)的模塊進(jìn)行測(cè)試。外部測(cè)試：進(jìn)行黑盒測(cè)試，對(duì)整個(gè)系統(tǒng)進(jìn)行測(cè)試。審核：檢查文件的完整性和正確性。資料審查：檢查文件的完整性和格式的正確性。批準(zhǔn)：審查該版本是否可以發(fā)行。委派他人對(duì)提交的文檔進(jìn)行抽查，驗(yàn)證其正確性和完備性。編號(hào)、錄入數(shù)據(jù)、刻盤：光盤的卷標(biāo)為8位數(shù)字的序列號(hào)，在根目錄下建立以版本編號(hào)為名稱的子目錄，所有提交的文檔資料存放在該子目錄中。版本啟用通知單JL/PLA10.05-2002名稱編號(hào)狀態(tài)配套版本簡(jiǎn)要描述日期光盤編號(hào)提交人版本號(hào)被取代的版本編號(hào)驗(yàn)證碼適用范圍編制人測(cè)試人資料審查復(fù)制要求修改的原因不能合并的原因測(cè)試結(jié)果審核意見(jiàn)批準(zhǔn)意見(jiàn)

說(shuō)明：欄目描述填寫人備注名稱要求填寫產(chǎn)品的全稱提交人編號(hào)由項(xiàng)目編號(hào)+分模塊編號(hào)+序列號(hào)構(gòu)成項(xiàng)目編號(hào)由4位數(shù)字構(gòu)成，分模塊編號(hào)由2位數(shù)字構(gòu)成，序列號(hào)由4位構(gòu)成該版本批準(zhǔn)后，編寫編號(hào)檔案管理員日期提交的日期提交人版本號(hào)提交人資料審查負(fù)責(zé)檢查提交文件的完整性，并將版本啟用單錄入計(jì)算機(jī)檔案管理員驗(yàn)證碼要求復(fù)制時(shí)能驗(yàn)證版本正確性的關(guān)鍵數(shù)據(jù)（代碼和、文件長(zhǎng)度等）提交人簡(jiǎn)要描述對(duì)該版本的簡(jiǎn)單描述提交人光盤編號(hào)由8位數(shù)字序列號(hào)構(gòu)成檔案管理員提交人負(fù)責(zé)提交所有的文件主要設(shè)計(jì)者適應(yīng)范圍描述適用的用戶和機(jī)器的批次提交人狀態(tài)作廢/使用檔案管理員編制人編寫該程序的人員簽名審核意見(jiàn)對(duì)提交的文件負(fù)責(zé)對(duì)被取代版本已發(fā)行產(chǎn)品的處理意見(jiàn)和該版本的使用時(shí)效項(xiàng)目負(fù)責(zé)人批準(zhǔn)意見(jiàn)技術(shù)部經(jīng)理修改原因?qū)懨鞲恼说腻e(cuò)誤或新增的功能提交人不能合并的原因在原來(lái)的版本基礎(chǔ)上產(chǎn)生了一個(gè)新版本時(shí)，但應(yīng)又不能取代原來(lái)版本時(shí)，必須說(shuō)明原因。提交人復(fù)制要求說(shuō)明發(fā)行版本的格式，版本載體的類型（介質(zhì)），復(fù)制的設(shè)備，復(fù)制的特殊要求提交人配套版本當(dāng)一個(gè)產(chǎn)品需要幾個(gè)軟件構(gòu)成，必須主要與該版本配套的版本的編號(hào)，或關(guān)系用“/”隔開(kāi)，與關(guān)系用“，”隔開(kāi)提交人測(cè)試人不能少于兩人測(cè)試該版本的所有人員的名單，要求簽名

附錄三：概要設(shè)計(jì)說(shuō)明書概述介紹該項(xiàng)目的名稱、任務(wù)提出者、提出的背景，應(yīng)用的目標(biāo)。功能和性能對(duì)照軟件需求說(shuō)明書，來(lái)說(shuō)明系統(tǒng)是如何滿足功能和性能需求的。開(kāi)發(fā)工具和平臺(tái)描述采用何種操作系統(tǒng)平臺(tái)、何種編程語(yǔ)言、開(kāi)發(fā)工具進(jìn)行開(kāi)發(fā)?？傮w結(jié)構(gòu)設(shè)計(jì)用圖表和文字方式說(shuō)明該系統(tǒng)由幾個(gè)模塊構(gòu)成，各模塊的功能、各模塊之間的關(guān)系。用數(shù)據(jù)流圖描述出數(shù)據(jù)在該系統(tǒng)中的流動(dòng)過(guò)程，在各模塊輸入前和輸出后數(shù)據(jù)的變換。用程序流程圖描述出主要功能的實(shí)現(xiàn)方式。接口設(shè)計(jì)外部接口說(shuō)明該系統(tǒng)同外部所有的接口安排，包括硬件接口、軟件接口、用戶接口。內(nèi)部接口說(shuō)明該系統(tǒng)內(nèi)部各個(gè)模塊之間的接口安排。系統(tǒng)數(shù)據(jù)結(jié)構(gòu)設(shè)計(jì)邏輯數(shù)據(jù)結(jié)構(gòu)設(shè)計(jì)給出該系統(tǒng)內(nèi)所使用的每個(gè)數(shù)據(jù)項(xiàng)、記錄、文件的標(biāo)識(shí)、定義、長(zhǎng)度以及他們之間的相互關(guān)系。物理數(shù)據(jù)結(jié)構(gòu)設(shè)計(jì)給出系統(tǒng)中的數(shù)據(jù)的存儲(chǔ)要求和訪問(wèn)方式、和存儲(chǔ)介質(zhì)。系統(tǒng)出錯(cuò)處理設(shè)計(jì)出錯(cuò)信息用表格形式列出每種可能的出錯(cuò)或故障情況出現(xiàn)時(shí)，系統(tǒng)輸出信息的形式、含義及處理方法。補(bǔ)救措施說(shuō)明故障出現(xiàn)后可能采取的變通措施，如后備技術(shù)、降效技術(shù)、恢復(fù)及再啟動(dòng)技術(shù)等。系統(tǒng)維護(hù)設(shè)計(jì)說(shuō)明為了系統(tǒng)維護(hù)方便而在程序內(nèi)部設(shè)計(jì)中作出的安排，如在程序中專門安排用于系統(tǒng)的檢查與維護(hù)的檢測(cè)點(diǎn)和專用模塊。關(guān)鍵的技術(shù)和難點(diǎn)描述開(kāi)發(fā)該系統(tǒng)采用的關(guān)鍵技術(shù)和難點(diǎn)，對(duì)關(guān)鍵技術(shù)和難點(diǎn)作出風(fēng)險(xiǎn)評(píng)估，要求作出相應(yīng)的解決對(duì)策，或提出其他的解決方案。交付方式交付的內(nèi)容全部的設(shè)計(jì)文件、發(fā)行版本、源程序交付的媒體介質(zhì)紙質(zhì)文件、電子文件、CD、FLASH、軟盤附錄四：需求說(shuō)明書簡(jiǎn)介介紹該項(xiàng)目的名稱、任務(wù)提出者、提出的背景，應(yīng)用的目標(biāo)詳細(xì)需求環(huán)境需求硬件環(huán)境描述運(yùn)行該軟件需要的設(shè)備能力處理器的速度、數(shù)量和內(nèi)存容量存儲(chǔ)媒體的容量輸入、輸出設(shè)備的種類和數(shù)量通訊網(wǎng)絡(luò)軟件環(huán)境運(yùn)行該軟件需要的操作系統(tǒng)、數(shù)據(jù)庫(kù)軟件、以及相應(yīng)的其他應(yīng)用軟件人員環(huán)境操作該軟件對(duì)人員的要求，人員的素質(zhì)、數(shù)量功能需求對(duì)系統(tǒng)中每一個(gè)功能，要求用圖示或文字詳細(xì)描述：概述——敘述功能名稱、目標(biāo)和作用輸入——詳述該功能輸入的信息處理——描述該功能作什么，如何對(duì)輸入信息進(jìn)行加工并轉(zhuǎn)換成輸出信息輸出——詳述該功能輸出的信息內(nèi)部生成數(shù)據(jù)——列出用戶所關(guān)心的內(nèi)部生成數(shù)據(jù)性能需求定量的描述該軟件系統(tǒng)應(yīng)滿足的具體性能需求精度說(shuō)明該軟件系統(tǒng)的精度要求，如：數(shù)據(jù)的精度要求數(shù)字計(jì)算的精度要求數(shù)據(jù)轉(zhuǎn)送的誤碼率要求時(shí)間特性說(shuō)明該軟件系統(tǒng)的時(shí)間要求，如：解題時(shí)間詢問(wèn)和更新數(shù)據(jù)文件的響應(yīng)時(shí)間系統(tǒng)各項(xiàng)功能的順序關(guān)系由于輸入類型的不同和操作方式的變化而引起的優(yōu)先順序在峰值負(fù)載期，與所規(guī)定的響應(yīng)時(shí)間的允許偏離范圍靈活性說(shuō)明當(dāng)需求發(fā)生某些變化時(shí)該軟件系統(tǒng)的適應(yīng)能力，指出為適應(yīng)這些變化而需要設(shè)計(jì)的軟件成分和過(guò)程輸入和輸出描述輸入和輸出的每個(gè)數(shù)據(jù)元素，對(duì)每個(gè)數(shù)據(jù)元素可列出如下信息：數(shù)據(jù)元素名同義名定義格式值域度量單位數(shù)據(jù)項(xiàng)名、縮寫詞和代碼對(duì)于輸入數(shù)據(jù)，還要說(shuō)明時(shí)間要求、優(yōu)先順序和輸入媒體。對(duì)于輸出數(shù)據(jù)，亦要說(shuō)明時(shí)間要求、優(yōu)先順序和輸出形式，并要描述對(duì)特殊輸入輸出項(xiàng)的保密要求和措施。數(shù)據(jù)庫(kù)特性詳細(xì)描述數(shù)據(jù)庫(kù)中要用到的每個(gè)數(shù)據(jù)元素，對(duì)每個(gè)數(shù)據(jù)元素可列出如下信息：數(shù)據(jù)元素名同義名定義格式值域度量單位數(shù)據(jù)項(xiàng)名、縮寫詞和代碼要根據(jù)記錄的規(guī)模和數(shù)量來(lái)估計(jì)數(shù)據(jù)存儲(chǔ)要求，并要預(yù)測(cè)數(shù)據(jù)的增長(zhǎng)率。故障處理列出在該系統(tǒng)出現(xiàn)故障時(shí)，為滿足信息處理要求而可能采取的技術(shù)措施，如：后備技術(shù)低效技術(shù)再啟動(dòng)技術(shù)接口說(shuō)明該軟件系統(tǒng)與其他系統(tǒng)和子系統(tǒng)的接口軟件接口和硬件接口安全和保密說(shuō)明該軟件系統(tǒng)在安全和保密方面的要求交付方式交付的內(nèi)容全部的設(shè)計(jì)文件、發(fā)行版本、源程序交付的媒體介質(zhì)紙質(zhì)文件、電子文件、CD、FLASH、軟盤附錄五：軟件開(kāi)發(fā)規(guī)范軟件開(kāi)發(fā)的流程和需要的文檔資料同項(xiàng)目開(kāi)發(fā)類似，在第章中有詳細(xì)的描述，在這不再作介紹了，僅介紹與軟件緊密相關(guān)的常用文檔資料的格式模板，以及編程設(shè)計(jì)中的若干規(guī)定常用文檔的格式模板流程圖概述國(guó)家標(biāo)準(zhǔn)GB1526-89《信息處理—數(shù)據(jù)流程圖、程序流程圖、系統(tǒng)流程圖、程序網(wǎng)絡(luò)圖和系統(tǒng)資源圖的文件編制符號(hào)及約定》規(guī)定了信息處理文件使用的各種符號(hào)及其使用的具體約定。要求采用VISIO或SMARTDRAW軟件繪制流程圖。流程圖所用符號(hào)及其簡(jiǎn)要說(shuō)明符號(hào)符號(hào)名簡(jiǎn)要說(shuō)明備注數(shù)據(jù)表示數(shù)據(jù)，其中可注明數(shù)據(jù)名、來(lái)源、用途或其他的文字說(shuō)明。此符號(hào)并不限定數(shù)據(jù)的媒體處理表示各種處理功能。符號(hào)內(nèi)可注明處理名或其簡(jiǎn)要功能既定處理表示已命名的既定處理。該處理為在另外地方已得到詳細(xì)說(shuō)明的一個(gè)操作或一組操作。例如子程序、函數(shù)、模塊。符號(hào)內(nèi)可注明處理名或其簡(jiǎn)要功能準(zhǔn)備表示修改一條指令或一組指令以影響隨后的活動(dòng)。例如：設(shè)置開(kāi)關(guān)、修改變址寄存器、初始化例行程序判斷表示判斷或開(kāi)關(guān)。符號(hào)內(nèi)可注明判斷的條件，它只有一個(gè)入口，但可以有若干可以選擇的出口。在對(duì)符號(hào)內(nèi)的條件求值后，有一個(gè)且只有一個(gè)出口被激活。求值結(jié)果可在表示出口路徑的流線附近寫出并行處理表示同步進(jìn)行兩個(gè)或兩個(gè)以上并行方式的操作。循環(huán)界限循環(huán)界限由上界限和下界限構(gòu)成，分別表示循環(huán)的開(kāi)始和結(jié)束。流線表示控制流的流向虛線用于表明被注解的范圍或連接被注解部分與注解正文連接符用于表明轉(zhuǎn)向流程圖的它處，或從它處轉(zhuǎn)入。它是流線的斷點(diǎn)。在圓內(nèi)注明某一標(biāo)志符，表明該流線將在具有相同標(biāo)志符的另一連接符處繼續(xù)下去。端點(diǎn)符程序流程的起點(diǎn)或結(jié)束注解符表示注解的內(nèi)容，虛線須連接到被注解的符號(hào)或符號(hào)組合上。省略符若流程圖中有些部分無(wú)需給出符號(hào)的具體形式和數(shù)量，可用省略符。省略符應(yīng)夾在流線符號(hào)之中。使用約定圖的布局流程圖所用的符號(hào)應(yīng)該均勻分布，連線保持合理的長(zhǎng)度，并盡量少使用長(zhǎng)線。符號(hào)標(biāo)志符這是賦予某個(gè)符號(hào)的標(biāo)志符，其作用是便于其他文件中引用該符號(hào)。符號(hào)標(biāo)志符要寫在符號(hào)的左上角。符號(hào)描述符它用于交叉引用，表達(dá)一個(gè)符號(hào)的特殊用途，或者進(jìn)一步理解某個(gè)符號(hào)的功能。描述符要寫在符號(hào)的右上角。連接的約定標(biāo)準(zhǔn)流向從左至右，自上而下箭頭的使用可隨時(shí)在流線上使用箭頭指示方向，當(dāng)流程不是標(biāo)準(zhǔn)流向時(shí)，一定要采用箭頭來(lái)指示方向。流線的交叉應(yīng)當(dāng)盡量避免流線的交叉，即使出現(xiàn)，交叉的流線之間沒(méi)有任何邏輯關(guān)系，不對(duì)流向產(chǎn)生影響。流線的匯集兩根或更多的進(jìn)入線可以匯集為一根輸出線，各連接點(diǎn)應(yīng)相互錯(cuò)開(kāi)以提高清晰度，并在必要時(shí)使用箭頭表示流向?；ミB一般情況下，流線應(yīng)從符號(hào)的左邊或頂端進(jìn)入，從右邊或底端離開(kāi)。它們都應(yīng)對(duì)準(zhǔn)符號(hào)的中心。多出口一個(gè)符號(hào)如有多個(gè)出口，應(yīng)按下述方式表示，在每個(gè)出口都應(yīng)標(biāo)有適當(dāng)?shù)臈l件值，以反映它所表示的邏輯路徑。數(shù)據(jù)結(jié)構(gòu)結(jié)構(gòu)名稱描述名稱定義描述使用特點(diǎn)數(shù)據(jù)字典數(shù)據(jù)字典和數(shù)據(jù)結(jié)構(gòu)圖可形成交互參照關(guān)系名稱定義描述使用特點(diǎn)項(xiàng)目計(jì)劃表要求采用PROJECT軟件制作，大致格式如下：項(xiàng)目名稱標(biāo)識(shí)號(hào)任務(wù)工期開(kāi)始時(shí)間完成時(shí)間提交件負(fù)責(zé)人擬制：校對(duì)：審核：批準(zhǔn)：第頁(yè)函數(shù)/過(guò)程接口函數(shù)名：必須與源程序中的一致，包括大小寫功能：簡(jiǎn)要說(shuō)明該函數(shù)/過(guò)程實(shí)現(xiàn)的功能，以及主要的算法，對(duì)重要的函數(shù)/過(guò)程可采用偽語(yǔ)言進(jìn)行描述入口參數(shù)：對(duì)入口參數(shù)作簡(jiǎn)要的說(shuō)明，利用全局變量，則也要說(shuō)明出口參數(shù)：對(duì)出口參數(shù)作簡(jiǎn)要的說(shuō)明，改變了全局變量，則也要說(shuō)明返回值：對(duì)函數(shù)的返回值說(shuō)明其類型和作用程序設(shè)計(jì)的若干規(guī)定這里例舉了C語(yǔ)言和匯編語(yǔ)言的規(guī)定，其他編程語(yǔ)言應(yīng)參照這些規(guī)定編寫C語(yǔ)言見(jiàn)附錄六匯編語(yǔ)言見(jiàn)附錄六附錄六：程序設(shè)計(jì)若干規(guī)定引言本文檔描述了項(xiàng)目開(kāi)發(fā)中的編程標(biāo)準(zhǔn)，其目的是提供一個(gè)編程的嚴(yán)格規(guī)則，使得程序有統(tǒng)一的風(fēng)格，以便于理解和維護(hù)，項(xiàng)目主要由C語(yǔ)言和匯編語(yǔ)言編寫.C語(yǔ)言產(chǎn)生新代碼圖D-1描述了產(chǎn)生C語(yǔ)言新代碼的格式，在寫新代碼之前，程序員必需首先將std.c拷貝到新文件中，然后編輯新文件以提供下列信息.目的提供一個(gè)關(guān)于程序的簡(jiǎn)要描述.版本狀態(tài)給出當(dāng)日的日期，程序員姓名，創(chuàng)建或修改.輸入列出及描述所有該程序?qū)⑤斎氲淖兞?，描述?yīng)簡(jiǎn)要而完全，有必要要描述一個(gè)組中不同的元素，或者一個(gè)詞的字節(jié)或位，如果沒(méi)有輸入變量,則鍵入"none".輸出列出及描述所有該函數(shù)的輸出變量，同時(shí)描述副作用，如果有的話.限制簡(jiǎn)要說(shuō)明程序的限制，例如數(shù)組長(zhǎng)度，算法等等，同時(shí)給出對(duì)未來(lái)版本的建議，如果沒(méi)有限制，給出“none”錯(cuò)誤信息描述出錯(cuò)信息或在出錯(cuò)時(shí)變量的置值，如果沒(méi)有的話給出“none”.方法簡(jiǎn)單描述程序中所有調(diào)用的算法及方法，如果方法很明顯，則刪去這一項(xiàng)，如果應(yīng)用了復(fù)雜的算法或方程式，請(qǐng)給出解釋及參考.外部變量描述僅列出及描述那些一般不為人所知的變量，如果該函數(shù)不用任何外部變量，給出“none”.局部、靜態(tài)、寄存器變量描述列出及描述局部，靜態(tài)寄存器變量，如果一個(gè)變量的用途可從其它變量名中明顯地看到，則不必給出解釋，變量名按字典順序列出./************************************************************本程序?qū)儆赬XXXXXXXX(公司名).作為商品機(jī)密 **版權(quán)所有,未經(jīng)許可不得公布或使用. *************************************************************.目的------函數(shù)的功能描述.版本狀態(tài)----11-7-90(程序員姓名)新代碼.輸入-----列出所有輸入變量和解釋.輸出-----列出所有輸出變量／參數(shù)／返回值及解釋.限制-----給出使用的算法和處理方法.錯(cuò)誤信息----描述錯(cuò)誤信息.方法----該函數(shù)中用的算法和處理方法.函數(shù)調(diào)用----列出調(diào)用的函數(shù).外部變量-----描述所有使用的外部變量.局部變量----描述局部變量.*/圖D-1C標(biāo)準(zhǔn)格式(in“std.c”)改舊代碼在函數(shù)頭上的所有必要的信息必須修改,版本狀態(tài)必須包含版本日期,程序員姓名,以及版本的簡(jiǎn)要描述,這種描述必須規(guī)格化,而且要包含足夠的信息,以便于對(duì)這些修改進(jìn)行回溯.版本狀態(tài)列出的順序必須使得最新的版本列在最上邊.所有其它的信息包括輸入、輸出、限制、以及函數(shù)調(diào)用等等,必須與最新的版本保持一致.編程常規(guī)下面說(shuō)明了C語(yǔ)言指令中的標(biāo)準(zhǔn)結(jié)構(gòu):程序設(shè)計(jì)風(fēng)格symbol183\f"Symbol"\s10\h 通過(guò)空格和空行,使程序有層次感,便于閱讀.symbol183\f"Symbol"\s10\h 提倡使用C++的語(yǔ)法和程序結(jié)構(gòu).symbol183\f"Symbol"\s10\h 所有代碼必須是小寫字符,以下的例外: 1。常量或宏(用#define或#typedef在include文件中定義的)必須用大寫字母. 2。在編譯或連接器中要求大寫的標(biāo)識(shí)符或庫(kù)函數(shù)名. 3。該文本中說(shuō)明的其它必須大寫的字母.symbol183\f"Symbol"\s10\h 代碼盡可能寫得簡(jiǎn)單、清晰、將復(fù)雜語(yǔ)句切成幾個(gè)簡(jiǎn)單的語(yǔ)句以增加可讀性.symbol183\f"Symbol"\s10\h 一般將子程序限制在100行以內(nèi).symbol183\f"Symbol"\s10\h 對(duì)于一個(gè)程序只允許一個(gè)入口和出口（在有出錯(cuò)處理等情況下可能允許有若干個(gè)出口）.symbol183\f"Symbol"\s10\h 設(shè)計(jì)的子程序必須有一個(gè)完整定義的輸出、輸入并且完成一個(gè)任務(wù).symbol183\f"Symbol"\s10\h 將密切相關(guān)的子程序存放在一個(gè)文件中.symbol183\f"Symbol"\s10\h 程序中盡量不使用直接數(shù),即盡量不在源程序中出現(xiàn)某個(gè)具體的數(shù)值,相應(yīng)的數(shù)值最好用#define語(yǔ)句定義成宏,以便于修改和維護(hù).symbol183\f"Symbol"\s10\h 使用統(tǒng)一的工作環(huán)境,建立子目錄,各目錄存放指定的內(nèi)容: src(源程序存放目錄) doc(文檔存放目錄) bin(可執(zhí)行程序存放目錄) lib(庫(kù)函數(shù)存放目錄) test(測(cè)試用目錄) inc(引用文件存放目錄) personal(各人自用目錄)symbol183\f"Symbol"\s10\h 使用make,Makefile進(jìn)行編譯,更新目標(biāo)文件和可執(zhí)行文件.C庫(kù)函數(shù)symbol183\f"Symbol"\s10\h 僅使用UnixSystemV、MicrosoftC、LatticC及TurboC編譯器中的庫(kù)函數(shù).symbol183\f"Symbol"\s10\h 在用"malloc"或"calloc"申請(qǐng)空間之后,建議測(cè)試一下不為空指針，若使用空指針，通常會(huì)導(dǎo)致系統(tǒng)的崩潰，或莫名其妙的錯(cuò)誤。symbol183\f"Symbol"\s10\h 在用"malloc"或"calloc"申請(qǐng)空間之后,必須牢記在不需要它們的時(shí)候調(diào)用free釋放空間以便于將來(lái)使用空間.類型說(shuō)明symbol183\f"Symbol"\s10\h 類型說(shuō)明的順序是由短到長(zhǎng): char short long float doublesymbol183\f"Symbol"\s10\h 盡量不使用int,用short或long取代,以免不同硬件環(huán)境的影響.symbol183\f"Symbol"\s10\h 僅僅使用var_style.h中用typedef定義的宏以便共享.變量名變量名的長(zhǎng)度沒(méi)有限制.但各個(gè)變量的前31個(gè)字符必須唯一.(各系統(tǒng)的狀態(tài)會(huì)有變化,盡可能在開(kāi)始時(shí)區(qū)分變量名).建議用英文語(yǔ)句的一般風(fēng)格命名變量名,英文單詞的首字母大寫，后面的字母小寫。對(duì)于外部(公共)變量或函數(shù)名,在第一個(gè)字符之前加"_",對(duì)局部的變量名,建議遵照下列格式:bxxx_或xxxx_b 字節(jié)變量cxxx_或xxxx_c 字符變量ixxx_或xxxx_i 數(shù)變量sxxx_或xxxx_s 字變量lxxx_或xxxx_l 長(zhǎng)變量fxxx_或xxxx_f 浮點(diǎn)變量dxxx_或xxxx_d 精變量fpxxx或xxxx_fp 文件指針xpxxx或xxxx_xp 指針變量(例:ipxxxx或xxxx_ip)注意：變量名不應(yīng)該和當(dāng)前系統(tǒng)采用的編譯器，以及與已知的其他編譯器中已定義的函數(shù)名或C的庫(kù)函數(shù)相同，也不應(yīng)與同C的關(guān)鍵字相同。比如：class不是C編譯器的關(guān)鍵字，但是C++的關(guān)鍵字，在用C編譯器開(kāi)發(fā)的系統(tǒng)中，不能采用class作為變量名，否則將影響移植性。寄存器變量在程序中找一個(gè)頻繁使用的變量(int或指針類型),將其定義成寄存器類以加快運(yùn)行速度，特別適用于循環(huán)變量中。外部變量symbol183\f"Symbol"\s10\h 外部變量必須在函數(shù)中以extern語(yǔ)句說(shuō)明.symbol183\f"Symbol"\s10\h 如果外部變量是數(shù)組,在外部說(shuō)明中,第一維必須為空.symbol183\f"Symbol"\s10\h 如果不同類型的變量要組在一起,用結(jié)構(gòu)取代數(shù)組.symbol183\f"Symbol"\s10\h 將外部變量說(shuō)明成static類,如果它們?cè)谝粋€(gè)文件中共享而不被其它文件訪問(wèn).常量symbol183\f"Symbol"\s10\h 對(duì)公共使用的常量,引用com_cons.h中定義的宏.for循環(huán)對(duì)于數(shù)組的處理,循環(huán)的結(jié)束用"<"取代"<=".例:inta[9];for(i=0;i<9;i++)...;...;if_else有elseif的語(yǔ)句,應(yīng)將if提上一行,例如:if() { ………. } elseif { ………. } 標(biāo)號(hào)所有標(biāo)號(hào)應(yīng)在第一列開(kāi)始goto除非絕對(duì)必要,避免使用gotodefault在switch語(yǔ)句中將default放在case的最后breaksymbol183\f"Symbol"\s10\h 在switch語(yǔ)句之外盡量少用break.symbol183\f"Symbol"\s10\h 在某些循環(huán)中為減少代碼層次可有限地使用break和continue.返回returnsymbol183\f"Symbol"\s10\h 即使不返回任何值,也應(yīng)在函數(shù)的出口處寫上return以示函數(shù)出口symbol183\f"Symbol"\s10\h 盡量在一個(gè)函數(shù)中使用一個(gè)return,個(gè)別情況例外(如有多個(gè)錯(cuò)誤處理時(shí)).大括號(hào)用大括號(hào)將一些語(yǔ)句組在一起小括號(hào)用"（）"避免操作順序的混亂.特別要注意以下兩點(diǎn)的應(yīng)用（通過(guò)例子來(lái)說(shuō)明）,也是程序設(shè)計(jì)中經(jīng)常不注意而犯的錯(cuò)誤：1、#definex y+3 (1) #definex (y+3) (2) 按(1)的定義z=x/3---〉z(mì)=y+3/3=y+1 按(2)的定義z=x/3--->z=(y+3)/3=y/3=1 2、char*buf; long*plong; plong=(long*)buf+2; (1) plong=(long*)(buf+2); (2) 如果buf=0;則在(1)中plong=8,(2)中plong=2;注釋symbol183\f"Symbol"\s10\h 在需要明確程序含義的地方應(yīng)勤于使用注釋,所有注釋寫成:/*......*/或//symbol183\f"Symbol"\s10\h 在語(yǔ)句后的注釋必須與語(yǔ)句在同一行: statement/*..._..*/ statement/*..._..*/symbol183\f"Symbol"\s10\h 如果注釋太長(zhǎng),超出一行,應(yīng)將其按如下格式放在語(yǔ)句之前:/*... ... ... ...*/symbol183\f"Symbol"\s10\h 如果變量需要注釋,它們必須一行行地進(jìn)行說(shuō)明,例如:inti;/*......*/匯編語(yǔ)言產(chǎn)生新模塊代碼圖D-2描述了產(chǎn)生匯編語(yǔ)言新模塊代碼的格式,在寫新代碼之前,程序員必需首先將model.asm拷貝到新文件中.然后編輯新文件以提供下列信息.目的提供一個(gè)關(guān)于程序模塊的簡(jiǎn)要描述.版本狀態(tài)給出當(dāng)日的日期,程序員姓名，版本號(hào)。COMMENT%************************************************************本程序?qū)儆赬XXXXXXXX(公司名).作為商品機(jī)密 **版權(quán)所有,未經(jīng)許可不得公布或使用. ************************************************************.目的------模塊的功能描述.版本狀態(tài)----11-7-90(程序員姓名)新代碼圖D-2ASM標(biāo)準(zhǔn)格式(in“model.asm”)產(chǎn)生新的子過(guò)程代碼圖D-3描述了產(chǎn)生匯編語(yǔ)言新的子過(guò)程代碼的格式,在寫新子過(guò)程代碼之前,程序員必需首先將Pro.asm拷貝到新子過(guò)程前.然后編輯新文件以提供下列信息.子過(guò)程名稱給出子過(guò)程的名稱功能描述用語(yǔ)言或偽C代碼提供一個(gè)關(guān)于該子過(guò)程的簡(jiǎn)要描述,并且簡(jiǎn)要說(shuō)明子過(guò)程的限制。版本狀態(tài)和歷史給出當(dāng)日的日期,程序員姓名.入口參數(shù)列出及描述所有該子過(guò)程將輸入的變量和寄存器，描述應(yīng)簡(jiǎn)要而完全,有必要描述一個(gè)組中不同的元素,或者一個(gè)詞的字節(jié)或位.如果沒(méi)有輸入變量,則鍵入“none”.出口參數(shù)列出及描述所有該子過(guò)程的輸出變量和寄存器,同時(shí)描述對(duì)全局變量的影響和被破壞的寄存器,如果有的話.同時(shí)還要描述出錯(cuò)信息或在出錯(cuò)時(shí)變量的值,如果沒(méi)有的話給出“none”.默認(rèn)的段寄存器和段名用ASSUME指出在該子過(guò)程中，默認(rèn)的段寄存器和段名的關(guān)系。COMMENT.子過(guò)程名稱----給出子過(guò)程的名稱.功能描述----提供一個(gè)關(guān)于子過(guò)程的簡(jiǎn)要描述，并且簡(jiǎn)要說(shuō)明子過(guò)程的限制..版本狀態(tài)和歷史----給出當(dāng)日的日期,程序員姓名..入口參數(shù)----列出及描述所有該子過(guò)程將輸入的變量和寄存器..出口參數(shù)----列出及描述所有該子過(guò)程的輸出變量和寄存器,并列出被破壞的寄存器..默認(rèn)的段寄存器和段名----用ASSUME指出在該子過(guò)程中，默認(rèn)的段寄存器和段名的關(guān)系。%圖D-3標(biāo)準(zhǔn)格式(in“pro.asm”)修改舊代碼在過(guò)程頭上的所有必要的信息必須修改,版本狀態(tài)必須包含版本日期,程序員姓名,以及版本的簡(jiǎn)要描述,這種描述必須規(guī)格化,而且要包含足夠的信息,以便于對(duì)這些修改進(jìn)行回溯.版本狀態(tài)列出的順序必須使得最新的版本列在最上邊.所有其它的信息包括輸入、輸出、限制、以及過(guò)程調(diào)用等等,必須與最新的版本保持一致.編程常規(guī)下面說(shuō)明了匯編語(yǔ)言指令中的標(biāo)準(zhǔn)結(jié)構(gòu):程序設(shè)計(jì)風(fēng)格symbol183\f"Symbol"\s10\h 應(yīng)該遵照MIRCOSOFTMASM5.0~6.0和TURBOASMBLE2.0~3.0的語(yǔ)言規(guī)范。建議不用簡(jiǎn)寫方式.symbol183\f"Symbol"\s10\h 在同一子過(guò)程中所有代碼必須是統(tǒng)一的小寫字符和大寫字母,以下的例外:(1)宏必須用大寫字母.(2)在編譯或連接器中要求大寫的標(biāo)識(shí)符或庫(kù)函數(shù)名.(3)該文本中說(shuō)明的其它必須大寫的字母.symbol183\f"Symbol"\s10\h 對(duì)于一個(gè)程序只允許一個(gè)入口和出口（在有出錯(cuò)處理等情況下可能允許有若干個(gè)出口）.symbol183\f"Symbol"\s10\h 設(shè)計(jì)的子程序必須有一個(gè)完整定義的輸出、輸入并且完成一個(gè)任務(wù).symbol183\f"Symbol"\s10\h 將密切相關(guān)的子程序存放在一個(gè)文件中.symbol183\f"Symbol"\s10\h 程序中盡量不使用直接數(shù),即盡量不在源程序中出現(xiàn)某個(gè)具體的數(shù)值,相應(yīng)的數(shù)值最好用EQU語(yǔ)句定義成宏,以便于修改和維護(hù).symbol183\f"Symbol"\s10\h 使用統(tǒng)一的工作環(huán)境,建立子目錄,各目錄存放指定的內(nèi)容:src(源程序存放目錄)doc(文檔存放目錄)bin(可執(zhí)行程序存放目錄)lib(庫(kù)函數(shù)存放目錄)test(測(cè)試用目錄)inc(引用文件存放目錄)personal(各人自用目錄)symbol183\f