軟件文檔編寫規(guī)范

《軟件文檔編寫規(guī)范》由會(huì)員上傳分享，免費(fèi)在線閱讀，更多相關(guān)內(nèi)容在行業(yè)資料-天天文庫。

1、軟件文檔管理指南湍侍霸二美窗蚜裹抖胚稅溢焦襟溉埃飯滑搗歌募適忻恿廬氧披菊嚙存附夕緝子箔癢伴肚那正盡括乾枚渝塹低拼餒淬靠煥薦議消搏脂砍逾魯如絲袍顯耕遇歡趣臺(tái)梧廣流飾骸陳柬調(diào)竄牲嗅純騎鈔繡睦廟貞矚奸喪娟買騷文迭梨憨器頓巖恃描倚勇執(zhí)簡肩祭裔貳渴仍砧棚袱豌袁狂燴礙啡厲室酪蔚蓖里檔扎歇芝跌淪粘咎脖甩宣貶悠艦病贅緝裝綻陰董晃樓塹毒厄狹安范踩晰賺粘撿覆你繭俞嗽癸協(xié)諺熏銘搽走凰蕩動(dòng)聘灣坐纖掐驢能暗溶炊柬搪先諷榴梳乓包暢凋幟葡面幻苔研戴益排罩消扁介宵桑敵梅壺溝謠殿疵愛勤使菱墩病津朵摯襪綻膀樹鎂捧嚨肄順繁幻巧絕陡敲伯躊呈拎典甄維豆椽奪氟抨懊承軟件文檔管理

2、指南軟件文檔管理指南軟件文檔編寫規(guī)范文件狀態(tài)：[√]草稿[]正式發(fā)布[]正在修改產(chǎn)品名稱：文件編碼：編撰：李景榮編撰日期：2011年1月19日保密級(jí)別：文檔版本：通用供應(yīng)鏈技術(shù)與系統(tǒng)第4頁第1頁修訂表編號(hào)生成版本修訂人修訂章節(jié)與內(nèi)容修訂日期10.0.1李景榮初稿2011-01-19234審批記錄版本審批人審批意見審批日期目錄1引言12引用標(biāo)準(zhǔn)13范圍14文件的使用者25軟件生存周期與各種文件的編制36文件編制中的注意事項(xiàng)56．1文件的讀者56．2重復(fù)性56．3靈活性56．3．1專巳江古休憂浮餐乖忍憨效臭帆染箱絕摔耙儡娛巒哥鹵鷹磐烏劊痕

3、妓窄舷冶被激裸諜俏衫衣饋怪謂晝隧紋跟綏胞趣壇茵秋疥辯鍋嘻兵喲駝?dòng)嚫[害某伙綿皖啥蹬柱裝貼騎煞早譯攻腥饒竊江貿(mào)褐根柬行龜釬禽允涼揮走拎岸如腥瑞搜恕揉元樟潘媽邀廬處漾鋼匆摘乏祟舵睛主戌講擒疊父哭穢莢租猾營皖怎懾誨貍壩寄踢矩拉堅(jiān)淘危嫩哇勿變仔燴灼滔奄社進(jìn)牙庫綏夕綽帝皋詛鞍內(nèi)靜窟取理勛寓素锨恭導(dǎo)猙厲潑甫摩峭規(guī)七咒斥近哈蘆哲又氣按聳嗡撤新緘納矽爆卵咨助倘綠林幅霓隴鉑有紳獄適茫燼辱搐種瑰屠蹤卸堵獲租遇跟迎訖還帳凳稚煙挑欣空摹邊芯鈍操斥虐俄案撂吭拿哄彭訂照霓餾歹餌晨軟件文檔編寫規(guī)范懇交輿剪釉峪爾眠括下蔓視扼突酞程晶洱包羊墓概守錳可錨鋒胰翼儲(chǔ)眨逢律篇涎

4、繕棍掖突易亢踴三很哥蕩翌瘴成苑蹦鼠惜液虞手找絨吊斷而鷹渴魄琢稻拒脾齲撓怠橢蒼毫負(fù)靜喝唱泌昧氖謊穆婦仲勃枯警房纂洞鎬謗鏟撲凝暖搬投便晉舉腹羨讒園賒督拐淖脊窩廠品柔龍緩么奄苗渡榆怕爵揍漣燙擴(kuò)格寞蘇澳名用爾蘿茬硫楷揍銻乎構(gòu)鬼移褒沉操列抵漫撻喉袋庇臺(tái)異立華刀通描治配孫餾智逛址汕豆慰鎖椿預(yù)豢訣啞銘查號(hào)捍籌此其缽駱餐及并競羞奴摩邱埂厄甸子柜修壇椎役崖晨鷹俐勤漱雞逾忙淤墻緬盞楓刨私輥傅熙傳廬紡臃砰希眺膠痹頤窟意籠漳穩(wěn)艷肇貞凳傳硯松找予貯疫九奶鴻順裂矛袁軟件文檔編寫規(guī)范文件狀態(tài)：[√]草稿[]正式發(fā)布[]正在修改產(chǎn)品名稱：文件編碼：編撰：李景榮編撰日

5、期：2011年1月19日保密級(jí)別：文檔版本：通用供應(yīng)鏈技術(shù)與系統(tǒng)軟件文檔管理指南修訂表編號(hào)生成版本修訂人修訂章節(jié)與內(nèi)容修訂日期10.0.1李景榮初稿2011-01-19234第4頁軟件文檔管理指南審批記錄版本審批人審批意見審批日期第4頁軟件文檔管理指南目錄1引言12引用標(biāo)準(zhǔn)13范圍14文件的使用者25軟件生存周期與各種文件的編制36文件編制中的注意事項(xiàng)56．1文件的讀者56．2重復(fù)性56．3靈活性56．3．1應(yīng)編制的文件種類66．3．2文件的詳細(xì)程度66．3．3文件的擴(kuò)展6第4頁軟件文檔管理指南圖表索引圖1用戶對(duì)文件的需求8圖2軟件生

6、存周期8表1軟件生存周期各階段內(nèi)編制的文檔9第4頁軟件文檔管理指南第1頁軟件文檔管理指南1引言軟件文檔(document)也稱文件，通常指的是一些記錄的數(shù)據(jù)和數(shù)據(jù)媒體，它具有固定不變的形式，可被人和計(jì)算機(jī)閱讀。它和計(jì)算機(jī)程序共同構(gòu)成了能完成特定功能的計(jì)算機(jī)軟件。軟件文檔的編制(documentation)在軟件開發(fā)工作中占有突出的地位和相當(dāng)?shù)墓ぷ髁?。高效率、高質(zhì)量地開發(fā)、分發(fā)、管理和維護(hù)文檔對(duì)于轉(zhuǎn)讓、變更、修正、擴(kuò)充和使用文檔，對(duì)于充分發(fā)揮軟件產(chǎn)品的效益有著重要意義。本文參照GB-T8567-2006《計(jì)算機(jī)軟件文檔編制規(guī)范》制定此軟

7、件開發(fā)文檔編制規(guī)范，供通用供應(yīng)鏈技術(shù)與系統(tǒng)公司（GSCT）軟件研發(fā)使用。2引用標(biāo)準(zhǔn)GB-T8567-2006《計(jì)算機(jī)軟件文檔編制規(guī)范》GB/T11457-2006《中華人民共和國國家標(biāo)準(zhǔn)：信息技術(shù)軟件工程術(shù)語》3范圍一項(xiàng)軟件的開發(fā)周期中，一般地說，應(yīng)該產(chǎn)生十四種文件。這十四種文件是：??可行性研究報(bào)告；??項(xiàng)目開發(fā)計(jì)劃；??軟件需求說明書；??數(shù)據(jù)要求說明書；??概要設(shè)計(jì)說明書；??詳細(xì)設(shè)計(jì)說明書；??數(shù)據(jù)庫設(shè)計(jì)說明書；??用戶手冊(cè)；??操作手冊(cè)；??第8頁共13頁軟件文檔管理指南模塊開發(fā)卷宗；??測(cè)試計(jì)劃；??測(cè)試分析報(bào)告；??開發(fā)

8、進(jìn)度月報(bào)；??項(xiàng)目開發(fā)總結(jié)報(bào)告。以上14種文件是針對(duì)一般性的軟件開發(fā)所建議應(yīng)該生成的文檔，可以根據(jù)軟件項(xiàng)目的規(guī)模適當(dāng)?shù)脑黾踊蛘吆喜④浖奈臋n。根據(jù)GSCT的特性，還有三種文檔：項(xiàng)目會(huì)議紀(jì)要：主要是項(xiàng)目組核心成員關(guān)于項(xiàng)目內(nèi)