系統(tǒng)開發(fā)的文檔管理

ftonny

（三）\r\n\r\n如何編寫高質(zhì)量“軟件需求說明書” （下）\r\n原著：Karl E Wieger，Process Impact \r\n\r\n需求質(zhì)量的評審\r\n\r\n　　這些有關(guān)需求質(zhì)量的特性的描述在理論上都是非常好的，但一個好的需求到底是個什么樣子的呢？為了體現(xiàn)得更切合實際，我們做個小練習(xí)。下面有幾個從實際的工程選出的需求，依據(jù)上面的質(zhì)量標(biāo)準(zhǔn)，評估每個需求，看看有什么問題，然后用更好的方式重寫。我將對每個例子都提出自己的分析和改進(jìn)的建議。也歡迎你提出不同的見解。我所占優(yōu)的只是我知道每個需求的出處。因為你我都不是真正的客戶，我們只能猜測每個需求的意圖。\r\n\r\n　　例1．“產(chǎn)品應(yīng)在不少于每60秒的正常周期內(nèi)提供狀態(tài)信息”\r\n　　這個需求是不完整的：狀態(tài)信息是什么，如何顯示給用戶。這個需求有幾處含糊。我們在談?wù)摦a(chǎn)品的哪部分？狀態(tài)信息間隔真的假定為不少于60秒？，甚者每10年顯示一條新的狀態(tài)信息也可以？也許它的意圖是消息間隔不應(yīng)超過60秒，那么1毫秒是不是太短？“每”這個詞導(dǎo)致了不確定性。問題的后果，就是需求的不可證實。\r\n彌補(bǔ)缺陷，重寫需求的一種方法：\r\n\r\n\r\n　　1、狀態(tài)信息\r\n　　1．1后臺任務(wù)管理器因該以誤差上下不超過10秒的60秒間隔，在用戶界面的指定位置顯示狀態(tài)信息\r\n　　1．2如果后臺進(jìn)程處理正常，那么應(yīng)該顯示任務(wù)已完成的百分?jǐn)?shù)/比\r\n　　1．3任務(wù)完成時，應(yīng)顯示相關(guān)的信息\r\n　　　1．4后臺任務(wù)出錯應(yīng)該顯示錯誤信息\r\n　　為了分別測試和追蹤，我將其分成了多個需求。如果將幾個需求串接在一節(jié)中，在構(gòu)造和測試時就很容易漏掉一個。\r\n\r\n　　例2．“產(chǎn)品應(yīng)瞬間在顯示和隱藏不可打印字符間切換” \r\n　　計算機(jī)在瞬間不能做任何事，所以這個需求不切實可行。它的不完整性表現(xiàn)在沒有聲明觸發(fā)狀態(tài)切換的條件。軟件要在某些條件下更改自己？或者用戶為了模仿更改要做一些動作？而且，在文檔中改變顯示的范圍是多大：選中的文本，整個的文檔，或其他的？這也是個模糊的問題。不可打印字符合隱藏字符一樣嗎？或者是一些屬性標(biāo)志或一些控制字符？問題的后果，就是需求的不可證實。\r\n\r\n\r\n　　象這樣編寫需求也許更好一些：“用戶能夠在一個由特定觸發(fā)條件激活處于編輯的文檔中在顯示和隱藏所有HTML標(biāo)記間切換”�，F(xiàn)在就很清楚，不可打印字符是HTML標(biāo)記。由于沒有定義觸發(fā)條件，需求對設(shè)計沒有約束力。只有設(shè)計人員選定了觸發(fā)條件后，你才能編寫測試驗證觸發(fā)的正確操作。\r\n\r\n　　例3．“HTML分析器可以產(chǎn)生HTML標(biāo)記錯誤報告，幫助HTML入門者快速解決錯誤”。單詞“快速”使其模糊，沒　　有加進(jìn)錯誤報告的定義也是其部完整。我不知道，你怎么驗證這個需求。找一個自稱為HTML的入門者，看看能不能根據(jù)錯誤報告快速解決錯誤？\r\n\r\n\r\n　　試試這個：“HTML分析器可以產(chǎn)生一個錯誤報告，錯誤報告包含有在被分析文件中出錯的HTML文本和行號以及錯誤的描述。如果沒有錯誤，就不會產(chǎn)生錯誤報告”�，F(xiàn)在我們知道了，什么會被加到出錯報告中，但是出錯報告是個什么樣子，則留由設(shè)計人員決定。我們還指定了一個例外：如果沒有發(fā)現(xiàn)錯誤，不產(chǎn)生錯誤報告。\r\n\r\n　　例4．“如果可能，主管號碼應(yīng)通過聯(lián)機(jī)校驗，而不是通過主全體主管號碼列表校驗”。真感到絕望，什么是“如果可能”：如果技術(shù)上可行？如果主全體主管號碼列表可以聯(lián)機(jī)獲得？要避免象“應(yīng)該”的這類不確切的詞。客戶是需要這個功能性還是不需要。我曾看過一些需求說明書，采用諸如：應(yīng)，將，應(yīng)該/將要等一些詞描述優(yōu)先級的細(xì)微差別。但我更喜歡用“應(yīng)”清楚的說明需求的意圖，指明優(yōu)先級。這是修改后的：系統(tǒng)應(yīng)校驗輸入的主管號碼而不通過聯(lián)機(jī)的主全體主官號碼列表。如果在列表中沒有發(fā)現(xiàn)主管號碼，將會顯示一條錯誤信息，也不接受指令。\r\n\r\n\r\n　　在理解各個已完成的糟糕需求上，開發(fā)人員將會遇到的難題是：開發(fā)人員與客戶將會在審核需求，未達(dá)成共識前發(fā)生激烈的爭論。詳細(xì)檢查大的需求文檔不是一件輕松的事情。我清楚有人做過，而且他們花在檢查上的每一分鐘都是值得的。相對于開發(fā)階段和用戶的抱怨電話，在這個階段修補(bǔ)缺陷是便宜的，\r\n\r\n編寫質(zhì)量需求的方針\r\n\r\n\r\n　　編寫優(yōu)秀的需求是沒有公式化的方法的。這需要大量的經(jīng)驗，要從你在過去的文檔中發(fā)現(xiàn)的問題學(xué)習(xí)。請在組織軟件需求文檔時，嚴(yán)格遵從這些方針。\r\n\r\n\r\n　　句子和段落要短。采用主動語氣。使用正確的語法，拼寫，標(biāo)點。使用術(shù)語，要保持一致性，并在術(shù)語表或數(shù)據(jù)字典中定義它們\r\n\r\n\r\n　　要看需求是否被有效的定義，可以以開發(fā)人員的觀點看看。在內(nèi)心將“當(dāng)你們做完了找我”這句加到文檔尾部，看看能不能是你緊張起來。換句話說，你是否需要SRS的編寫者的額外解釋幫助開發(fā)人員很好的理解需求，以便于設(shè)計和實現(xiàn)？如果是的話，在繼續(xù)工作前，需求還需要細(xì)化。\r\n\r\n\r\n　　需求編寫者還要努力正確地把握細(xì)化程度。要避免包含多個需求的長的敘述段落。有幫助的提示是編寫?yīng)毩⒌目蓽y試的需求。如果你認(rèn)為一小部分測試可以驗證一個需求的正確，那么它已經(jīng)正確的細(xì)化了。如果你預(yù)想到多種不同類的測試，幾個需求可能已擠到了一起，需要拆分開。 \r\n\r\n\r\n　　密切關(guān)注多個需求合成了單個需求。一個需求中的連接詞“和”/“或”建議幾個需求合并。不要在一個需求中使用“和”/“或”。\r\n\r\n\r\n　　通篇文檔細(xì)節(jié)上要保持一致。我曾看見過多個需求說明書前后不一致。如：“對于紅色合法的顏色代碼應(yīng)是R”及“對于綠色合法的顏色代碼應(yīng)是G”就有可以以分散的需求分離開，而“產(chǎn)品應(yīng)能對來自語音編輯指示做出反應(yīng)”應(yīng)作為一個子系統(tǒng)，不應(yīng)作為單個的功能性需求。\r\n\r\n\r\n　　避免在SRS中過多的申述需求。在多處包含相同的需求可以使文檔更易于閱讀，但也會給文檔的維護(hù)增加困難。文檔的多份文本要在同一時間內(nèi)全部更新，避免不一致性。\r\n\r\n　　如果你遵從了這些方針，你能夠盡早地經(jīng)常正式或非正式的審查需求，這些需求對于產(chǎn)品的構(gòu)造，系統(tǒng)測試以及最后的客戶滿意，都會成為好的奠基石。并且要記住，沒有高質(zhì)量的需求，軟件就象一盒巧克力，你永遠(yuǎn)不知道你會得到什么。\r\n\r\n(to be continued)

ftonny

（四）\r\n\r\n程序文檔合一與動態(tài)文檔 \r\n\r\n洪海 廖靜 \r\n\r\n　　很多企業(yè)已經(jīng)建立了許多龐大的計算機(jī)管理系統(tǒng)，而且將不斷地推出新的系統(tǒng)。滿足經(jīng)營的需求須不斷維護(hù)、改造計算機(jī)系統(tǒng)，但同時又要不影響現(xiàn)行生產(chǎn)，所以必須建立一整套機(jī)制來評價、控制和完成對系統(tǒng)的維護(hù)。在軟件維護(hù)過程中，提出程序與文檔合一的概念在軟件開發(fā)的同時建立動態(tài)文檔。 \r\n\r\n程序與文檔合一概念的提出 \r\n\r\n\r\n一、目前軟件的狀況 \r\n\r\n\r\n　　程序與文檔的形式分離，不僅是用各自獨立的形式存放，而且使用不同的工具在不同的時間里書寫和檢索。維護(hù)程序時不能方便地得到文檔的幫助，不能同步修改文檔。 \r\n\r\n\r\n　　程序與文檔的內(nèi)容分離，由于程序與文檔采用不同的描述，既有計算機(jī)語言也有自然語言。維護(hù)過程中不能及時、一致地更新文檔或程序，使文檔不能準(zhǔn)確地描述程序而幾乎成為廢紙甚至帶來負(fù)面價值。 \r\n\r\n\r\n　　軟件開發(fā)與維護(hù)的分離，絕大多數(shù)軟件在設(shè)計、開發(fā)時不太考慮以后可能的修改，加大了軟件維護(hù)的難度，而且使維護(hù)容易引入新的錯誤。 \r\n\r\n\r\n　　這些分離也表現(xiàn)在設(shè)計、開發(fā)的不同階段的文檔之間的不相容性，例如：需求分析說明書是紙上的東西，在概要設(shè)計階段不能很好地繼承、利用需求分析說明書，設(shè)計、編制概要設(shè)計時必須從零開始，需要重新分析、理解需求分析，這種思維上的脫節(jié)，不僅延緩開發(fā)進(jìn)度、加重設(shè)計人員的負(fù)擔(dān)，而且由于理解上的不同導(dǎo)致不同階段描述的對象有許多不相容情況。這些分離使得文檔在系統(tǒng)的設(shè)計、開發(fā)、維護(hù)中的作用下降，這也是很多軟件人員不愿意編寫文檔的主要原因。 \r\n\r\n二、程序與文檔合一的概念提出 \r\n\r\n\r\n　　怎樣才是好的文檔系統(tǒng)呢？應(yīng)當(dāng)具備以下屬性： \r\n　　1. 能夠準(zhǔn)確地描述軟件、并且簡單易懂； \r\n　　2. 能夠迅速錯誤定位、影響分析、修正設(shè)計； \r\n　　3. 能夠提高軟件維護(hù)質(zhì)量； \r\n　　4. 能夠方便程序修改時理解程序。 \r\n\r\n\r\n　　為此提出了程序與文檔合一的概念。這概念使軟件成為真正意義上的軟件：程序+文檔，程序就是文檔，文檔集成在程序中。它要求在選擇開發(fā)環(huán)境時不僅要考慮環(huán)境對設(shè)計、開發(fā)的完美支持，而且要考慮對維護(hù)、文檔的支持；它要求軟件人員在設(shè)計、開發(fā)過程中要考慮維護(hù)問題、文檔問題；它要求程序與文檔存儲在同一位置、同一系統(tǒng)中；它要求使用相同工具進(jìn)行程序與文檔的書寫、檢索；它要求在編寫和維護(hù)程序的同時形成文檔，在書寫文檔時編寫、維護(hù)程序。程序與文檔合一的概念不僅存在于系統(tǒng)的設(shè)計、開發(fā)階段而且存在于系統(tǒng)的維護(hù)階段，它貫穿軟件的生命周期。 \r\n\r\n\r\n　　動態(tài)文檔系統(tǒng)是建立在程序與文檔合一的概念基礎(chǔ)上的、文檔與程序一致的、簡單易懂的聯(lián)機(jī)文檔系統(tǒng)。它包括構(gòu)件說明與數(shù)據(jù)描述、對構(gòu)件與構(gòu)件之間、構(gòu)件與數(shù)據(jù)之間的關(guān)系進(jìn)行的描述。動態(tài)文檔系統(tǒng)是提高了文檔的可用性、易用性和連貫性，使文檔更加有效，是解決維護(hù)問題的有效途徑。 \r\n\r\n動態(tài)文檔系統(tǒng)問題分析 \r\n\r\n\r\n　　需要解決的問題是：軟件文檔的內(nèi)容劃分與獲取、文檔的存儲與維護(hù)、文檔的檢索、軟件文檔的生成打印。 \r\n\r\n一、軟件文檔的內(nèi)容劃分成：語義文檔、結(jié)構(gòu)文檔、過程文檔 \r\n\r\n\r\n　　語義文檔是對軟件的功能、概念、總體設(shè)計、流程、規(guī)約等用自然語言的描述，是軟件人員根據(jù)規(guī)范在使用CASE工具編寫并填入程序的文檔，它也是為更全面的解釋文檔而靈活加入的額外信息。 \r\n\r\n\r\n　　結(jié)構(gòu)文檔是在軟件設(shè)計工具、開發(fā)環(huán)境中對象的屬性、構(gòu)件間接口、構(gòu)件間引用關(guān)系、軟件的結(jié)構(gòu)等的描述。利用詞法、語法分析程序?qū)φ麄�系統(tǒng)的對象、構(gòu)件進(jìn)行識別、分析，獲取上述描述并形成表格文件。 \r\n\r\n\r\n　　過程文檔是對軟件的設(shè)計、編碼、維護(hù)過程中形成的過程描述和程序注釋，如設(shè)計目的、設(shè)計人、時間等說明，利用開發(fā)環(huán)境對軟件人員在設(shè)計、開發(fā)、維護(hù)過程中操作的記錄形成操作跟蹤。 \r\n\r\n二、程序與文檔的統(tǒng)一存儲與維護(hù) \r\n\r\n\r\n　　根據(jù)程序與文檔合一的概念和文檔從程序中提取的要求，文檔必須存放在程序中，甚至文檔固有的源代碼中。結(jié)構(gòu)如此的程序源代碼的存儲必須采用一種新技術(shù)—對象倉儲（Repository）技術(shù)，而不能采用流式文件，這樣才能使程序與文檔既結(jié)合又分離。程序與文檔結(jié)合在一個對象倉儲中，結(jié)合在統(tǒng)一的開發(fā)環(huán)境中；結(jié)合在修改代碼時可以同時修改文檔、修改文檔時可以同時人工檢查和修改程序，并在多次文檔生成而不會丟失手工輸入的文檔。程序與文檔應(yīng)當(dāng)分別存放在對象倉儲中的不同表或不同的字段中，在編譯與運(yùn)行時分離。 \r\n\r\n三、文檔的檢索 \r\n\r\n\r\n　　對單個對象、構(gòu)件文檔的檢索方式是若于文檔存放在一個對象倉儲中，它可以隨源代碼一起檢索和維護(hù)。這種檢索給分析和維護(hù)單個構(gòu)件、對象提供文檔支持。建立多種視圖、編寫程序?qū)φ麄�系統(tǒng)進(jìn)行文檔的檢索和獲取，完成對整個系統(tǒng)的分析，對整個系統(tǒng)進(jìn)行實時文檔支持。這將在例子中較詳細(xì)的描述。 \r\n\r\n四、軟件文檔的生成打印 \r\n\r\n\r\n　　編寫程序檢索和獲取整個系統(tǒng)的文檔，按照國家軟件標(biāo)準(zhǔn)的文檔式樣建立文檔模板并將按模板生成文檔和利用文字處理軟件強(qiáng)大的功能進(jìn)行創(chuàng)建、編輯文檔并打印。 \r\n\r\n\r\n　　根據(jù)上述分析，文檔分布和獲取對開發(fā)環(huán)境提出了要求：開發(fā)環(huán)境應(yīng)該是設(shè)計工具、開發(fā)工具的集成，應(yīng)該基于CASE技術(shù)、對象倉儲技術(shù)、構(gòu)件技術(shù)、OLE技術(shù)�；�于CASE技術(shù)的開發(fā)環(huán)境；設(shè)計、開發(fā)、維護(hù)過程中形成的文檔并植入程序代碼中，使文檔成為程序的一部分�；�于對象倉儲技術(shù)的開發(fā)環(huán)境，將文檔與程序統(tǒng)一存儲在對象倉儲中方便檢索�；�于構(gòu)件技術(shù)的開發(fā)環(huán)境，便于識別、獲取構(gòu)件，分析、形成結(jié)構(gòu)文檔和過程文檔�；�于OLE等技術(shù)使文檔可以很好地利用Word等文檔處理軟件。 \r\n\r\n動態(tài)文檔系統(tǒng)的一個應(yīng)用實例 \r\n\r\n\r\n　　廣州電信科技開發(fā)有限公司自行設(shè)計、開發(fā)的名為九七系統(tǒng)的龐大的電信管理計算機(jī)系統(tǒng)自1997年投產(chǎn)驗收后，將長期用于生產(chǎn)，維護(hù)工作非常重要和緊迫。這為動態(tài)文檔系統(tǒng)提供了需求和試驗場所。在長期維護(hù)的過程中，體會到好文檔的重要性并提出了程序文檔合一的概念，這為動態(tài)文檔系統(tǒng)提供了理論基礎(chǔ)。九七系統(tǒng)是使用Uniface開發(fā)環(huán)境。這種開發(fā)環(huán)境采用了CASE技術(shù)、對象倉儲技術(shù)、構(gòu)件技術(shù)，這為動態(tài)文檔系統(tǒng)提供了技術(shù)支撐。 \r\n\r\n一、廣州電信動態(tài)文檔系統(tǒng)的建立步驟 \r\n\r\n\r\n　　1. 理解Uniface、Oracle工具的開發(fā)環(huán)境，規(guī)劃語義文檔在各級對象中存放的表與字段，并根據(jù)工具的特性制定填寫的規(guī)則。 \r\n\r\n\r\n　　2. 尋找結(jié)構(gòu)文檔、過程文檔在Uniface、Oracle工具中存放的表與字段。 \r\n\r\n\r\n　　3. 在設(shè)計、開發(fā)和維護(hù)軟件的過程中對這些表或字段按照規(guī)則進(jìn)行填寫。 \r\n\r\n\r\n　　4. 建立一整套模板使文檔結(jié)構(gòu)與信息源建立映像，包括：數(shù)據(jù)字典模板、設(shè)計文檔模板、結(jié)構(gòu)文檔模板、開發(fā)過程文檔模板等。 \r\n\r\n\r\n　　5. 將這些模板組裝成文檔系統(tǒng)，并使它獨立于開發(fā)目標(biāo)系統(tǒng)。 \r\n\r\n\r\n　　廣州電信動態(tài)文檔系統(tǒng)的組成可以分為文檔查詢、維護(hù)記錄查詢、文檔生成。 \r\n\r\n\r\n　　文檔查詢不僅包括構(gòu)件說明與數(shù)據(jù)描述，而且包括對構(gòu)件與數(shù)據(jù)之間的關(guān)系的描述，是實時的聯(lián)機(jī)文檔查詢系統(tǒng)。維護(hù)記錄查詢是對軟件維護(hù)過程中的各個環(huán)節(jié)進(jìn)程進(jìn)行記錄與追蹤，用于規(guī)范維護(hù)工作。它包括問題報告、問題分析、錯誤定位、維護(hù)設(shè)計、維護(hù)執(zhí)行、確認(rèn)測試、維護(hù)評審、維護(hù)提交、問題跟蹤等。文檔生成則是根據(jù)需要實時生成軟件設(shè)計說明書。 \r\n\r\n\r\n二、程序與文檔合一概念與動態(tài)文檔系統(tǒng)的意義 \r\n\r\n\r\n　　廣州電信動態(tài)文檔系統(tǒng)的基本任務(wù)是輔助錯誤定位、維護(hù)影響分析、記錄維護(hù)進(jìn)程、生成文檔。使用Uniface的開發(fā)環(huán)境開發(fā)的，可以安裝在用Uniface開發(fā)的不同的應(yīng)用系統(tǒng)中。該系統(tǒng)已經(jīng)在九七計費(fèi)系統(tǒng)的維護(hù)中發(fā)揮重要作用。 \r\n\r\n\r\n　　它推崇的程序與文檔合一的概念，提出文檔就是程序，程序就是文檔的思路，文檔融合在程序中的構(gòu)思并已實現(xiàn)，這一概念指導(dǎo)了軟件人員進(jìn)行有效地工作。合一的概念貫穿了設(shè)計、開發(fā)、維護(hù)整個軟件周期，保證了文檔之間的繼承性和一致性，在設(shè)計、開發(fā)每一階段是繼承前階段的程序和文檔的結(jié)果。這樣極大地消除了程序與文檔、文檔與文檔之間的不一致性，加快了軟件設(shè)計進(jìn)度，提高了軟件開發(fā)、維護(hù)的質(zhì)量。它是軟件工程在具體應(yīng)用中的一種嘗試，它從程序文檔合一的角度出發(fā)，進(jìn)一步規(guī)范軟件設(shè)計、開發(fā)、維護(hù)。程序文檔合一的概念為軟件開發(fā)環(huán)境發(fā)展提供了一種思路；設(shè)計更好的對象倉儲來滿足開發(fā)、維護(hù)人員對程序文檔合一的概念的需求。 \r\n\r\n動態(tài)文檔系統(tǒng)的局限與發(fā)展 \r\n\r\n\r\n　　廣州電信動態(tài)文檔系統(tǒng)有很大的局限性，只能用于Uniface或Oracle開發(fā)的系統(tǒng)中。目前的廣州電信動態(tài)文檔系統(tǒng)的構(gòu)件的識別與獲取主要依賴開發(fā)工具提供的構(gòu)件和構(gòu)件的特征進(jìn)行識別的。這種動態(tài)文檔系統(tǒng)難以在一些3GL工具—未使用對象倉儲技術(shù)、構(gòu)件技術(shù)開發(fā)的軟件—中實現(xiàn)程序與文檔的合一與分離。大型軟件系統(tǒng)的環(huán)境是復(fù)雜的，往往采用了多種開發(fā)環(huán)境，如何對其他開發(fā)環(huán)境進(jìn)行支持還要進(jìn)行技術(shù)探討和實踐上的摸索。 \r\n\r\n\r\n　　另一個局限問題是目前的動態(tài)文檔系統(tǒng)描述的是程序文檔，其主要在編碼、維護(hù)的過程中進(jìn)行建設(shè)，系統(tǒng)進(jìn)入維護(hù)階段使用。如何使動態(tài)文檔系統(tǒng)不僅對軟件維護(hù)階段進(jìn)行支持，而且對軟件的設(shè)計、開發(fā)階段進(jìn)行更多的支持？一種可能的解決途徑是將軟件復(fù)用技術(shù)拓寬到包括文檔復(fù)用，包括程序復(fù)用、程序文檔復(fù)用和設(shè)計文檔復(fù)用，而且將動態(tài)文檔系統(tǒng)建立在基于這種軟件復(fù)用系統(tǒng)之上。 \r\n\r\n(To be continued)

ftonny

（五）\r\n\r\n軟件文檔知多少？  \r\nFishman \r\n\r\n　　如今，軟件開發(fā)越來越復(fù)雜，軟件功能也越來越豐富。而幾乎所有成熟的商業(yè)軟件，都是靠一個開發(fā)團(tuán)隊齊心協(xié)力的血汗結(jié)晶。“羅馬不是一天建成的！”，當(dāng)我們震撼于Microsoft Windows的驚世巨著的同時，也道聽途說了微軟公司軟件工程是如何的完善規(guī)范。的確，集數(shù)百名員工幾年的共同努力之大成，軟件項目管理的成敗是控制開發(fā)成本的關(guān)鍵環(huán)節(jié)。這里面，少不了貫穿其中的重要步驟----軟件文檔。 \r\n\r\n\r\n　　軟件文檔可以分為開發(fā)文檔和產(chǎn)品文檔兩大類。\r\n\r\n　　開發(fā)文檔包括：《功能要求》、《投標(biāo)方案》、《需求分析》、《技術(shù)分析》、《系統(tǒng)分析》、《數(shù)據(jù)庫文檔》、《功能函數(shù)文檔》、《界面文檔》、《編譯手冊》、《QA文檔》、《項目總結(jié)》等。 \r\n\r\n\r\n　　產(chǎn)品文檔包括：《產(chǎn)品簡介》、《產(chǎn)品演示》、《疑問解答》、《功能介紹》、 《技術(shù)白皮書》、《評測報告》、《安裝手冊》、《使用手冊》、《維護(hù)手冊》、 《用戶報告》、《銷售培訓(xùn)》等。 \r\n\r\n\r\n一、開發(fā)文檔 \r\n\r\n\r\n　　1. 《功能要求》--來源于客戶要求和市場調(diào)查，是軟件開發(fā)中最早期的一個環(huán)節(jié)�？蛻籼岢鲆粋�模糊的功能概念，或者要求解決一個實際問題，或者參照同類軟件的一個功能。有軟件經(jīng)驗的客戶還會提供比較詳細(xì)的技術(shù)規(guī)范書，把他們的要求全部列表書寫在文檔中，必要時加以圖表解說。這份文檔是需求分析的基礎(chǔ)。 \r\n\r\n\r\n　　2. 《投標(biāo)方案》--根據(jù)用戶的功能要求，經(jīng)過與招標(biāo)方溝通和確認(rèn)，技術(shù)人員開始書寫《投標(biāo)方案》，方案書一般包括以下幾個重要的章節(jié)： \r\n\r\n\r\n　　前言--項目背景、公司背景和業(yè)務(wù)、技術(shù)人員結(jié)構(gòu)、公司的成功案例介紹等。 \r\n\r\n\r\n　　需求分析--項目要求、軟件結(jié)構(gòu)、功能列表、功能描述、注意事項等。 \r\n\r\n\r\n　　技術(shù)方案--總體要求和指導(dǎo)思想、技術(shù)解決方案、軟件開發(fā)平臺、網(wǎng)絡(luò)結(jié)構(gòu)體系等。 \r\n\r\n\r\n　　項目管理--描述公司的軟件開發(fā)流程、工程實施服務(wù)、組織和人員分工、開發(fā)進(jìn)度控制、軟件質(zhì)量保證、項目驗收和人員培訓(xùn)、軟件資料文檔等。 \r\n\r\n\r\n　　技術(shù)支持--公司的技術(shù)支持和服務(wù)介紹、服務(wù)宗旨和目標(biāo)、服務(wù)級別和響應(yīng)時間、技術(shù)服務(wù)區(qū)域、技術(shù)服務(wù)期限、授權(quán)用戶聯(lián)系人等。 \r\n\r\n\r\n　　系統(tǒng)報價--軟、硬件平臺報價列表、軟件開發(fā)費(fèi)用、系統(tǒng)維護(hù)費(fèi)用等。 \r\n\r\n\r\n　　項目進(jìn)度--整個項目的進(jìn)度計劃，包括簽署合同、項目啟動、需求分析、系統(tǒng)分析、程序開發(fā)、測試維護(hù)、系統(tǒng)集成、用戶驗收、用戶培訓(xùn)等步驟的時間規(guī)劃。 \r\n\r\n\r\n　　3. 《需求分析》--包括產(chǎn)品概述、主要概念、操作流程、功能列表和解說、注意事項、系統(tǒng)環(huán)境等。以《功能要求》為基礎(chǔ)，進(jìn)行詳細(xì)的功能分析(包括客戶提出的要求和根據(jù)開發(fā)經(jīng)驗建議的功能)，列出本產(chǎn)品是什么，有什么特殊的概念，包括那些功能分類，需要具備什么功能，該功能的操作如何，實現(xiàn)的時候該注意什么細(xì)節(jié)，客戶有什么要求，系統(tǒng)運(yùn)行環(huán)境的要求等。這里的功能描述跟以后的使用手冊是一致的。 \r\n\r\n\r\n　　4. 《技術(shù)分析》--包括技術(shù)選型、技術(shù)比較、開發(fā)人員、關(guān)鍵技術(shù)問題的解決、技術(shù)風(fēng)險、技術(shù)升級方向、技術(shù)方案評價，競爭對手技術(shù)分析等。以《需求分析》為基礎(chǔ)，進(jìn)行詳細(xì)的技術(shù)分析(產(chǎn)品的性能和實現(xiàn)方法)，列出本項目需要使用什么技術(shù)方案，為什么，有哪些技術(shù)問題要解決 ，估計開發(fā)期間會碰到什么困難，技術(shù)方案以后如何升級，對本項目的技術(shù)有什么評價等。 \r\n\r\n\r\n　　5. 《系統(tǒng)分析》--包括功能實現(xiàn)、模塊組成、功能流程圖、函數(shù)接口、數(shù)據(jù)字典、軟件開發(fā)需要考慮的各種問題等。以《需求分析》為基礎(chǔ)，進(jìn)行詳細(xì)的系統(tǒng)分析(產(chǎn)品的開發(fā)和實現(xiàn)方法)，估計開發(fā)期間需要把什么問題說明白，程序員根據(jù)《系統(tǒng)分析》，開始在項目主管的帶領(lǐng)下進(jìn)行編碼。 \r\n\r\n\r\n　　6. 《數(shù)據(jù)庫文檔》--包括數(shù)據(jù)庫名稱、表名、字段名、字段類型、字段說明、備注、字段數(shù)值計算公式等。以《系統(tǒng)分析》為基礎(chǔ)，進(jìn)行詳細(xì)的數(shù)據(jù)庫設(shè)計。必要時可以用圖表解說，特別是關(guān)系數(shù)據(jù)庫。 \r\n\r\n\r\n　　7. 《功能函數(shù)文檔》--包括變量名、變量初植、功能，函數(shù)名，參數(shù)，如何調(diào)用、備注、注意事項等。以《系統(tǒng)分析》為基礎(chǔ)，進(jìn)行詳細(xì)的說明，列出哪個功能涉及多少個函數(shù)，以便以后程序員修改、接手和擴(kuò)展。 \r\n\r\n\r\n　　8. 《界面文檔》--包括軟件外觀、界面素材、編輯工具、文件名、菜單、按鈕和其它界面部件的要求，這里與軟件完成后的運(yùn)行界面是一致的。 \r\n\r\n\r\n　　9. 《編譯手冊》--包括服務(wù)器編譯環(huán)境、操作系統(tǒng)、編譯工具、GNU的C++編譯器版本信息、目錄說明、程序生成、源程序文件列表、Makefile配置及其相關(guān)程序的對應(yīng)關(guān)系列表。客戶端的編譯過程、編譯結(jié)果、編譯示例、編譯環(huán)境、操作系統(tǒng)、編譯工具、源文件列表和制作安裝程序的過程。 \r\n\r\n\r\n　　10. 《QA文檔》--包括產(chǎn)品簡介、產(chǎn)品原理、產(chǎn)品功能列表、功能描述、功能流程、執(zhí)行結(jié)果、數(shù)據(jù)庫結(jié)構(gòu)、測試要求等，提供給軟件測試人員使用。 \r\n\r\n\r\n　　11. 《項目總結(jié)》--包括項目簡介、項目參與人員和開發(fā)時間、項目風(fēng)險管理過程、項目功能列表、項目結(jié)構(gòu)特點、技術(shù)特點、對項目的升級建議、對以后的項目的建議、人員素質(zhì)情況等。 \r\n\r\n二、產(chǎn)品文檔 \r\n\r\n\r\n　　1. 《產(chǎn)品簡介》--包括公司背景、產(chǎn)品概念、適用范圍、產(chǎn)品功能、功能特點、運(yùn)行要求和公司聯(lián)系地址。 \r\n\r\n\r\n　　2. 《產(chǎn)品演示》--包括公司簡介、產(chǎn)品背景、產(chǎn)品描述、產(chǎn)品特點、產(chǎn)品作用、適用范圍、使用分析、功能模塊、解決問題、合作伙伴、成功案例等。一般用Power \r\npoint或者VCD錄制軟件實現(xiàn)。 \r\n\r\n\r\n　　3. 《疑問解答》--列出用戶關(guān)心的問題和處理方法。用于解答軟件的操作功能和解決用戶的疑難問題。 \r\n\r\n\r\n　　4. 《功能介紹》--以《需求分析》為書寫基礎(chǔ)，包括軟件介紹、軟件結(jié)構(gòu)、功能列表、功能描述和公司聯(lián)系地址。 \r\n\r\n\r\n　　5. 《技術(shù)白皮書》--以《技術(shù)分析》為書寫基礎(chǔ)，包括功能實現(xiàn)、技術(shù)選型、關(guān)鍵技術(shù)問題的解決、技術(shù)方案特點、技術(shù)升級方向等。 \r\n\r\n\r\n　　6. 《評測報告》--第三方權(quán)威評測報告。包括評測目的、評測范圍、評測環(huán)境、評測內(nèi)容、實測數(shù)據(jù)、性能表現(xiàn)、結(jié)果分析和評測總結(jié)等。 \r\n\r\n\r\n　　7. 《安裝手冊》--包括系統(tǒng)環(huán)境、運(yùn)行平臺、產(chǎn)品安裝過程、初始環(huán)境設(shè)置、安裝記錄等。 \r\n\r\n\r\n　　8. 《使用手冊》--包括產(chǎn)品簡介、功能列表、功能描述和解釋、功能操作、客戶服務(wù)和聯(lián)系方式等。 \r\n\r\n\r\n　　9. 《維護(hù)手冊》--包括產(chǎn)品簡介、系統(tǒng)須知、初始環(huán)境設(shè)置、系統(tǒng)配置、數(shù)據(jù)管理和備份、技術(shù)問題解答和聯(lián)系方式等。 \r\n\r\n\r\n　　10. 《用戶報告》--包括產(chǎn)品簡介、購買時間、使用目的、使用時間、使用地點、實施過程、出現(xiàn)問題和解決、產(chǎn)品總結(jié)和建議等。 \r\n\r\n\r\n　　11.《銷售培訓(xùn)》--包括項目簡介、產(chǎn)品功能、產(chǎn)品特點、商業(yè)優(yōu)勢、系統(tǒng)運(yùn)行環(huán)境、適用范圍、目標(biāo)客戶等。 \r\n\r\n(To be continued)

jinzhi

這么多，要不發(fā)一個附件上來，比較好整理，謝謝\r\ndownloading

ftonny

俺也是一個一個找出來的，您慢慢看吧......

ftonny

（五）\r\n\r\n計算機(jī)軟件產(chǎn)品開發(fā)文件編制指南（GB 8567-88）之一 \r\n\r\n黎宇 （轉(zhuǎn)載自國家計算機(jī)標(biāo)準(zhǔn)和文件模板）　　2002年04月17日 \r\n\r\n引言 \r\n\r\n1 目的 \r\n\r\n\r\n　　一項計算機(jī)軟件的籌劃、研制及實現(xiàn)，構(gòu)成一個軟件開發(fā)項目。一個軟件開發(fā)項目的進(jìn)行，一般需要 在人力和自動化資源等方面作重大的投資。為了保證項目開發(fā)的成功，最經(jīng)濟(jì)地花費(fèi)這些投資，并且便 于運(yùn)行和維護(hù)，在開發(fā)工作的每一階段，都需要編制二定的文件。這些文件連同計算機(jī)程序及數(shù)據(jù)一起， 構(gòu)成為計算機(jī)軟件。文件是計算機(jī)軟件中不可缺少的組成部分，它的作用是：\r\n\r\n\r\n　　a．作為開發(fā)人員在一定階段內(nèi)的工作成果和結(jié)束標(biāo)志；\r\n\r\n\r\n　　b．向管理人員提供軟件開發(fā)過程中的進(jìn)展和情況，把軟件開發(fā)過程中的一些\"不可見的\"事物轉(zhuǎn) 換成\"可見?quot;文字資料。以便管理人員在各個階段檢查開發(fā)計劃的實施進(jìn)展，使之能夠判斷原定目標(biāo)是 否已達(dá)到，還將繼續(xù)耗用資源的種類和數(shù)量；\r\n\r\n\r\n　　C．記錄開發(fā)過程中的技術(shù)信息，便于協(xié)調(diào)以后的軟件開發(fā)、使用和修改；\r\n\r\n\r\n　　d．提供對軟件的有關(guān)運(yùn)行、維護(hù)和培訓(xùn)的信息，便于管理人員、開發(fā)人員、操作人員和用戶之間相 互了解彼此的工作；\r\n\r\n\r\n　　e．向潛在用戶報導(dǎo)軟件的功能和性能，使他們能判定該軟件能否服務(wù)于自己的需要。\r\n\r\n\r\n　　換言之，本指南認(rèn)為：文件的編制必須適應(yīng)計算機(jī)軟件整個生存周期的需要。\r\n\r\n\r\n　　計算機(jī)軟件所包含的文件有兩類：一類是開發(fā)過程中填寫的各種圖表，可稱之為工作表格；另一類 則是應(yīng)編制的技術(shù)資料或技術(shù)管理資料，可稱之為文件。本指南規(guī)定軟件文件的編制形式，并提供對這 些規(guī)定的解釋。本指南的目的是使得所編制的軟件文件確實能夠起到軟件文件應(yīng)該發(fā)揮的作用。\r\n\r\n2 范圍\r\n\r\n\r\n　　本指南是一份指導(dǎo)性文件。本指甫建議，在一項計算機(jī)軟件的開發(fā)過程中，一般地說，應(yīng)該產(chǎn)生十四 種文件。這十四種文件是：\r\n\r\n\r\n　　可行性研究報告；\r\n　　項目開發(fā)計劃；\r\n　　軟件需求說明書；\r\n　　數(shù)據(jù)要求說明書；\r\n　　概要設(shè)計說明書；\r\n　　詳細(xì)設(shè)計說明書；\r\n　　數(shù)據(jù)庫設(shè)計說明書；\r\n　　用戶手冊；\r\n　　操作手冊；\r\n　　模塊開發(fā)卷宗；\r\n　　測試計劃；\r\n　　測試分析報告；\r\n　　開發(fā)進(jìn)度月報； \r\n　　項目開發(fā)總結(jié)報告。\r\n\r\n\r\n　　本指南將給出開發(fā)過程中建議產(chǎn)生的這十四種文件的編制指導(dǎo)，同時，本指南也是這十四種文件的 編寫質(zhì)量的檢驗準(zhǔn)則。但是，本指南并未涉及軟件開發(fā)過程中如何填寫工作表格的問題。\r\n\r\n\r\n　　一般地說，一個軟件總是一個計算機(jī)系統(tǒng)（包括硬件、固件和軟件）的組成部分。鑒于計算機(jī)系統(tǒng)的 多樣性，本指南一般不涉及整個系統(tǒng)開發(fā)中的文件編制問題，本指南僅僅是軟件開發(fā)過程中的文件編制指南。 \r\n\r\n3 文件的使用者 \r\n\r\n\r\n　　對于使用文件的人員而言，他們所關(guān)心的文件的種類，隨他們所承擔(dān)的工作而異。\r\n\r\n\r\n　　管理人員：可行性研究報告，項目開發(fā)計劃，模塊開發(fā)卷宗，開發(fā)進(jìn)度月報，項目開發(fā)總結(jié)報告； \r\n\r\n\r\n　　開發(fā)人員：可行性研究報告，項目開發(fā)計劃，軟件需求說明書，數(shù)據(jù)要求說明書， 概要設(shè)計說明書，詳細(xì)設(shè)計說明書，數(shù)據(jù)庫設(shè)計說明書，測試計劃，測試分析報告；\r\n\r\n　　維護(hù)人員：設(shè)計說明書，測試分析報告，模塊開發(fā)卷宗；\r\n\r\n　　用戶：用戶手冊， 操作手冊。\r\n\r\n\r\n　　盡管本指南提出了在軟件開發(fā)中文件編制的要求，但并不意味著這些文件都必須交給用戶。一項軟件的用戶應(yīng)該得到的文件的種類由供應(yīng)者與用戶之間簽訂的合同規(guī)定。\r\n \r\n(To be continued）

ftonny

（五）\r\n\r\n計算機(jī)軟件產(chǎn)品開發(fā)文件編制指南（GB 8567-88）之一 \r\n\r\n黎宇 （轉(zhuǎn)載自國家計算機(jī)標(biāo)準(zhǔn)和文件模板）　　2002年04月17日 \r\n\r\n引言 \r\n\r\n1 目的 \r\n\r\n\r\n　　一項計算機(jī)軟件的籌劃、研制及實現(xiàn)，構(gòu)成一個軟件開發(fā)項目。一個軟件開發(fā)項目的進(jìn)行，一般需要 在人力和自動化資源等方面作重大的投資。為了保證項目開發(fā)的成功，最經(jīng)濟(jì)地花費(fèi)這些投資，并且便 于運(yùn)行和維護(hù)，在開發(fā)工作的每一階段，都需要編制二定的文件。這些文件連同計算機(jī)程序及數(shù)據(jù)一起， 構(gòu)成為計算機(jī)軟件。文件是計算機(jī)軟件中不可缺少的組成部分，它的作用是：\r\n\r\n\r\n　　a．作為開發(fā)人員在一定階段內(nèi)的工作成果和結(jié)束標(biāo)志；\r\n\r\n\r\n　　b．向管理人員提供軟件開發(fā)過程中的進(jìn)展和情況，把軟件開發(fā)過程中的一些\"不可見的\"事物轉(zhuǎn) 換成\"可見?quot;文字資料。以便管理人員在各個階段檢查開發(fā)計劃的實施進(jìn)展，使之能夠判斷原定目標(biāo)是 否已達(dá)到，還將繼續(xù)耗用資源的種類和數(shù)量；\r\n\r\n\r\n　　C．記錄開發(fā)過程中的技術(shù)信息，便于協(xié)調(diào)以后的軟件開發(fā)、使用和修改；\r\n\r\n\r\n　　d．提供對軟件的有關(guān)運(yùn)行、維護(hù)和培訓(xùn)的信息，便于管理人員、開發(fā)人員、操作人員和用戶之間相 互了解彼此的工作；\r\n\r\n\r\n　　e．向潛在用戶報導(dǎo)軟件的功能和性能，使他們能判定該軟件能否服務(wù)于自己的需要。\r\n\r\n\r\n　　換言之，本指南認(rèn)為：文件的編制必須適應(yīng)計算機(jī)軟件整個生存周期的需要。\r\n\r\n\r\n　　計算機(jī)軟件所包含的文件有兩類：一類是開發(fā)過程中填寫的各種圖表，可稱之為工作表格；另一類 則是應(yīng)編制的技術(shù)資料或技術(shù)管理資料，可稱之為文件。本指南規(guī)定軟件文件的編制形式，并提供對這 些規(guī)定的解釋。本指南的目的是使得所編制的軟件文件確實能夠起到軟件文件應(yīng)該發(fā)揮的作用。\r\n\r\n2 范圍\r\n\r\n\r\n　　本指南是一份指導(dǎo)性文件。本指甫建議，在一項計算機(jī)軟件的開發(fā)過程中，一般地說，應(yīng)該產(chǎn)生十四 種文件。這十四種文件是：\r\n\r\n\r\n　　可行性研究報告；\r\n　　項目開發(fā)計劃；\r\n　　軟件需求說明書；\r\n　　數(shù)據(jù)要求說明書；\r\n　　概要設(shè)計說明書；\r\n　　詳細(xì)設(shè)計說明書；\r\n　　數(shù)據(jù)庫設(shè)計說明書；\r\n　　用戶手冊；\r\n　　操作手冊；\r\n　　模塊開發(fā)卷宗；\r\n　　測試計劃；\r\n　　測試分析報告；\r\n　　開發(fā)進(jìn)度月報； \r\n　　項目開發(fā)總結(jié)報告。\r\n\r\n\r\n　　本指南將給出開發(fā)過程中建議產(chǎn)生的這十四種文件的編制指導(dǎo)，同時，本指南也是這十四種文件的 編寫質(zhì)量的檢驗準(zhǔn)則。但是，本指南并未涉及軟件開發(fā)過程中如何填寫工作表格的問題。\r\n\r\n\r\n　　一般地說，一個軟件總是一個計算機(jī)系統(tǒng)（包括硬件、固件和軟件）的組成部分。鑒于計算機(jī)系統(tǒng)的 多樣性，本指南一般不涉及整個系統(tǒng)開發(fā)中的文件編制問題，本指南僅僅是軟件開發(fā)過程中的文件編制指南。 \r\n\r\n3 文件的使用者 \r\n\r\n\r\n　　對于使用文件的人員而言，他們所關(guān)心的文件的種類，隨他們所承擔(dān)的工作而異。\r\n\r\n\r\n　　管理人員：可行性研究報告，項目開發(fā)計劃，模塊開發(fā)卷宗，開發(fā)進(jìn)度月報，項目開發(fā)總結(jié)報告； \r\n\r\n\r\n　　開發(fā)人員：可行性研究報告，項目開發(fā)計劃，軟件需求說明書，數(shù)據(jù)要求說明書， 概要設(shè)計說明書，詳細(xì)設(shè)計說明書，數(shù)據(jù)庫設(shè)計說明書，測試計劃，測試分析報告；\r\n\r\n　　維護(hù)人員：設(shè)計說明書，測試分析報告，模塊開發(fā)卷宗；\r\n\r\n　　用戶：用戶手冊， 操作手冊。\r\n\r\n\r\n　　盡管本指南提出了在軟件開發(fā)中文件編制的要求，但并不意味著這些文件都必須交給用戶。一項軟件的用戶應(yīng)該得到的文件的種類由供應(yīng)者與用戶之間簽訂的合同規(guī)定。\r\n \r\n(To be continued）

ftonny

（五）\r\n\r\n計算機(jī)軟件產(chǎn)品開發(fā)文件編制指南（GB 8567-88）之一 \r\n\r\n黎宇 （轉(zhuǎn)載自國家計算機(jī)標(biāo)準(zhǔn)和文件模板）　　2002年04月17日 \r\n\r\n引言 \r\n\r\n1 目的 \r\n\r\n\r\n　　一項計算機(jī)軟件的籌劃、研制及實現(xiàn)，構(gòu)成一個軟件開發(fā)項目。一個軟件開發(fā)項目的進(jìn)行，一般需要 在人力和自動化資源等方面作重大的投資。為了保證項目開發(fā)的成功，最經(jīng)濟(jì)地花費(fèi)這些投資，并且便 于運(yùn)行和維護(hù)，在開發(fā)工作的每一階段，都需要編制二定的文件。這些文件連同計算機(jī)程序及數(shù)據(jù)一起， 構(gòu)成為計算機(jī)軟件。文件是計算機(jī)軟件中不可缺少的組成部分，它的作用是：\r\n\r\n\r\n　　a．作為開發(fā)人員在一定階段內(nèi)的工作成果和結(jié)束標(biāo)志；\r\n\r\n\r\n　　b．向管理人員提供軟件開發(fā)過程中的進(jìn)展和情況，把軟件開發(fā)過程中的一些\"不可見的\"事物轉(zhuǎn) 換成\"可見?quot;文字資料。以便管理人員在各個階段檢查開發(fā)計劃的實施進(jìn)展，使之能夠判斷原定目標(biāo)是 否已達(dá)到，還將繼續(xù)耗用資源的種類和數(shù)量；\r\n\r\n\r\n　　C．記錄開發(fā)過程中的技術(shù)信息，便于協(xié)調(diào)以后的軟件開發(fā)、使用和修改；\r\n\r\n\r\n　　d．提供對軟件的有關(guān)運(yùn)行、維護(hù)和培訓(xùn)的信息，便于管理人員、開發(fā)人員、操作人員和用戶之間相 互了解彼此的工作；\r\n\r\n\r\n　　e．向潛在用戶報導(dǎo)軟件的功能和性能，使他們能判定該軟件能否服務(wù)于自己的需要。\r\n\r\n\r\n　　換言之，本指南認(rèn)為：文件的編制必須適應(yīng)計算機(jī)軟件整個生存周期的需要。\r\n\r\n\r\n　　計算機(jī)軟件所包含的文件有兩類：一類是開發(fā)過程中填寫的各種圖表，可稱之為工作表格；另一類 則是應(yīng)編制的技術(shù)資料或技術(shù)管理資料，可稱之為文件。本指南規(guī)定軟件文件的編制形式，并提供對這 些規(guī)定的解釋。本指南的目的是使得所編制的軟件文件確實能夠起到軟件文件應(yīng)該發(fā)揮的作用。\r\n\r\n2 范圍\r\n\r\n\r\n　　本指南是一份指導(dǎo)性文件。本指甫建議，在一項計算機(jī)軟件的開發(fā)過程中，一般地說，應(yīng)該產(chǎn)生十四 種文件。這十四種文件是：\r\n\r\n\r\n　　可行性研究報告；\r\n　　項目開發(fā)計劃；\r\n　　軟件需求說明書；\r\n　　數(shù)據(jù)要求說明書；\r\n　　概要設(shè)計說明書；\r\n　　詳細(xì)設(shè)計說明書；\r\n　　數(shù)據(jù)庫設(shè)計說明書；\r\n　　用戶手冊；\r\n　　操作手冊；\r\n　　模塊開發(fā)卷宗；\r\n　　測試計劃；\r\n　　測試分析報告；\r\n　　開發(fā)進(jìn)度月報； \r\n　　項目開發(fā)總結(jié)報告。\r\n\r\n\r\n　　本指南將給出開發(fā)過程中建議產(chǎn)生的這十四種文件的編制指導(dǎo)，同時，本指南也是這十四種文件的 編寫質(zhì)量的檢驗準(zhǔn)則。但是，本指南并未涉及軟件開發(fā)過程中如何填寫工作表格的問題。\r\n\r\n\r\n　　一般地說，一個軟件總是一個計算機(jī)系統(tǒng)（包括硬件、固件和軟件）的組成部分。鑒于計算機(jī)系統(tǒng)的 多樣性，本指南一般不涉及整個系統(tǒng)開發(fā)中的文件編制問題，本指南僅僅是軟件開發(fā)過程中的文件編制指南。 \r\n\r\n3 文件的使用者 \r\n\r\n\r\n　　對于使用文件的人員而言，他們所關(guān)心的文件的種類，隨他們所承擔(dān)的工作而異。\r\n\r\n\r\n　　管理人員：可行性研究報告，項目開發(fā)計劃，模塊開發(fā)卷宗，開發(fā)進(jìn)度月報，項目開發(fā)總結(jié)報告； \r\n\r\n\r\n　　開發(fā)人員：可行性研究報告，項目開發(fā)計劃，軟件需求說明書，數(shù)據(jù)要求說明書， 概要設(shè)計說明書，詳細(xì)設(shè)計說明書，數(shù)據(jù)庫設(shè)計說明書，測試計劃，測試分析報告；\r\n\r\n　　維護(hù)人員：設(shè)計說明書，測試分析報告，模塊開發(fā)卷宗；\r\n\r\n　　用戶：用戶手冊， 操作手冊。\r\n\r\n\r\n　　盡管本指南提出了在軟件開發(fā)中文件編制的要求，但并不意味著這些文件都必須交給用戶。一項軟件的用戶應(yīng)該得到的文件的種類由供應(yīng)者與用戶之間簽訂的合同規(guī)定。\r\n \r\n(To be continued）

ftonny

（六）\r\n\r\n計算機(jī)軟件產(chǎn)品開發(fā)文件編制指南（GB 8567-88）之二 （上）\r\n黎宇 （轉(zhuǎn)載自國家計算機(jī)標(biāo)準(zhǔn)和文件模板）　　2002年04月22日 \r\n\r\n第一篇 文件的編制指導(dǎo) \r\n\r\n4 軟件生存周期與各種文件的編制\r\n\r\n\r\n　　一項計算機(jī)軟件，從出現(xiàn)一個構(gòu)思之日起，經(jīng)過這項軟件開發(fā)成功投入使用，直到最后決定停止使 用，并被另一一項軟件代替之時止，被認(rèn)為是該軟件的一個生存周期。一般地說這個軟件生存周期可以分成以下六個階段：\r\n\r\n　　可行性與計劃研究階段\r\n　　需求分析階段\r\n　　設(shè)計階段 \r\n　　實現(xiàn)階段 \r\n　　測試階段\r\n　　運(yùn)行與維護(hù)階段 \r\n\r\n\r\n　　在可行性研究與計劃階段內(nèi)，要確定該軟件的開發(fā)目標(biāo)和總的要求，要進(jìn)行可行性分析、投資一收益分析、制訂開發(fā)計劃，并完成應(yīng)編制的文件。\r\n\r\n\r\n　　在需求分析階段內(nèi)，由系統(tǒng)分析人員對被設(shè)計的系統(tǒng)進(jìn)行系統(tǒng)分析，確定對該軟件的各項功能、性能需求和設(shè)計約束，確定對文件編制的要求，作為本階段工作的結(jié)果，一般地說，軟件需求說明書、數(shù)據(jù)要求說明書和初步的用戶手冊應(yīng)該編寫出來。\r\n\r\n\r\n　　在設(shè)計階段內(nèi)，系統(tǒng)設(shè)計人員和程序設(shè)計人員應(yīng)該在反復(fù)理解軟件需求的基礎(chǔ)上，提出多個設(shè)計，分析每個設(shè)計能履行的功能并進(jìn)行相互比較，最后確定一個設(shè)計，包括該軟件的結(jié)構(gòu)、模塊的劃分、功能的分配以及處理流程。在被設(shè)計系統(tǒng)比較復(fù)雜的情況下，設(shè)計階段應(yīng)分解成概要設(shè)計階段和詳細(xì)設(shè)計階段兩個步驟。在一般情況下，應(yīng)完成的文件包括：概要設(shè)計說明書、詳細(xì)設(shè)計說明書和測試計劃初稿。\r\n\r\n\r\n　　在實現(xiàn)階段內(nèi)，要完成源程序的編碼、編譯（或匯編）和排錯調(diào)試得到無語法錯的程序清單，要開始編寫模塊開發(fā)卷宗，并且要完成用戶手冊、操作手冊等面向用戶的文件的編寫工作，還要完成測試計劃的編制。\r\n\r\n\r\n　　在測試階段，該程序?qū)⒈蝗�面地測試，已編制的文件將被檢查審閱。一般要完成模塊開發(fā)卷宗和測試分析報告，作為開發(fā)工作的結(jié)束，所生產(chǎn)的程序、文件以及開發(fā)工作本身將逐項被評價，最后寫出項目開發(fā)總結(jié)報告。\r\n\r\n\r\n　　在整個開發(fā)過程中（即前五個階段中），開發(fā)集體要按月編寫開發(fā)進(jìn)度月報。 \r\n\r\n\r\n　　在運(yùn)行和維護(hù)階段，軟件將在運(yùn)行使用中不斷地被維護(hù)，根據(jù)新提出的需求進(jìn)行必要而且可能的擴(kuò)充和刪改。\r\n\r\n\r\n　　對于一項軟件而言，其生存周期各階段與各種文件編寫工作的關(guān)系可見表互，其中有些文件的編寫工作可能要在若干個階段中延續(xù)進(jìn)行。\r\n\r\n\r\n表1軟件生存周期各階段中的文件編制  \r\n\r\n\r\n5 文件編制中的考慮因素 \r\n\r\n\r\n　　文件編制是一個不斷努力的工作過程。是一個從形成最初輪廓，經(jīng)反復(fù)檢查和修改，直到程序和文件正式交付使用的完整過程。其中每一步都要求工作人員做出很大努力。要保證文件編制的質(zhì)量，要體現(xiàn)每個開發(fā)項目的特點，也要注意不要花太多的人力。為此，編制中要考慮如下各項因素。 \r\n\r\n5．1 文件的讀者\(yùn)r\n\r\n\r\n　　每一種文件都具有特定的讀者。這些讀者包括個人或小組、軟件開發(fā)單位的成員或社會上的公眾、從事軟件工作的技術(shù)人員、管理人員或領(lǐng)導(dǎo)干部。他們期待著使用這些文件的內(nèi)容來進(jìn)行工作，例如設(shè)計、編寫程序、測試、使用、維護(hù)或進(jìn)行計劃管理。因此，這些文件的作者必須了解自己的讀者，這些文件的編寫必須注意適應(yīng)自己的特定讀者的水平、特點和要求。 \r\n\r\n5．2 重復(fù)性\r\n\r\n\r\n　　本指南第二篇中將列出的這十四種文件的內(nèi)容要求中，顯然存在某些重復(fù)。較明顯的重復(fù)有兩類。引言是每一種文件都要包含的內(nèi)容，以向讀者提供總的梗概。第二類明顯的重復(fù)是各種文件中的說明部分，如對功能性能的說明、對輸入和輸出的描述、系統(tǒng)中包含的設(shè)備等。這是為了方便每種文件各自的讀者，每種產(chǎn)品文件應(yīng)該自成體系，盡量避免讀一種文件時又不得不去參考另一種文件。當(dāng)然，在每一種文件里，有關(guān)引言、說明等同其他文件相重復(fù)的部分，在行文上、在所用的術(shù)語上、在詳細(xì)的程度上，還是應(yīng)該有一些差別，以適應(yīng)各種文件的不同讀者的需要。\r\n\r\n5．3 靈活性\r\n\r\n\r\n　　鑒于軟件開發(fā)是具有創(chuàng)造性的腦力勞動，也鑒于不同軟件在規(guī)模上和復(fù)雜程度上差別極大，本指南認(rèn)為在文件編制工作中應(yīng)允許一定的靈活性。這種靈活性表現(xiàn)在如下各款。\r\n\r\n(To be continued)

ftonny

（七）\r\n\r\n計算機(jī)軟件產(chǎn)品開發(fā)文件編制指南（GB 8567-88）之二 （下）\r\n黎宇 （轉(zhuǎn)載自國家計算機(jī)標(biāo)準(zhǔn)和文件模板）　　2002年04月22日 \r\n\r\n\r\n5．3．1 應(yīng)編制的文件種類 \r\n\r\n\r\n　　盡管本指南認(rèn)為在一般情況下，一項軟件的開發(fā)過程中，應(yīng)產(chǎn)生的文件有十四種，然而針對一項具體的軟件開發(fā)項目，有時不必編制這么多的文件，可以把幾種文件合并成一種。一般地說，當(dāng)項目的規(guī)模、復(fù)雜性和成敗風(fēng)險增大時，文件編制的范圍、管理手續(xù)和詳細(xì)程度將隨之增加。反之，則可適當(dāng)減少。為了恰當(dāng)?shù)卣莆者@種靈活性，本指南要求貫徹分工負(fù)責(zé)的原則，這意味著： \r\n\r\n\r\n　　a: 一個軟件開發(fā)單位的領(lǐng)導(dǎo)機(jī)構(gòu)應(yīng)該根據(jù)本單位經(jīng)營承包的應(yīng)用軟件的專業(yè)領(lǐng)域和本單位的管理能力，制定一個對文件編制要求的實施規(guī)定，主要是：在不同的條件下，應(yīng)該形成哪些文件？這些文件的詳細(xì)程度？該開發(fā)單位的每一個項目負(fù)責(zé)人，必須認(rèn)真執(zhí)行這個實施規(guī)定。這種規(guī)定的兩個例子可嘆 本指南的附錄o（參考件）；\r\n\r\n\r\n　　b．對于一個具體的應(yīng)用軟件項目，項目負(fù)責(zé)人應(yīng)根據(jù)上述實施規(guī)定，確定一個文件編制計劃，主 中包括:\r\n\r\n\r\n　�。�1）應(yīng)該編制哪幾種文件，詳細(xì)程度如何？\r\n　�。�2）各個文件的編制負(fù)責(zé)人和進(jìn)度要求；\r\n　�。�3）審查、批準(zhǔn)的負(fù)責(zé)人和時間進(jìn)度安排； \r\n　�。�4）在開發(fā)時期內(nèi)，各文件的維護(hù)、修改和管理的負(fù)責(zé)人，以及批準(zhǔn)手續(xù)。 \r\n\r\n\r\n　　每項工作必須落實到人。\r\n\r\n\r\n　　這個文件編制計劃是整個開發(fā)計劃的重要組成部分；\r\n　　C．有關(guān)的設(shè)計人員則必須嚴(yán)格執(zhí)行這個文件編制計劃。\r\n\r\n5．3．2 文件的詳細(xì)程度\r\n\r\n\r\n　　從同一份提綱起草的文件的篇幅大小往往不同，可以少到幾頁，也可以長達(dá)幾百頁。對于這種差別本指南是允許的。此詳細(xì)程度取決于任務(wù)的規(guī)模、復(fù)雜性和項目負(fù)責(zé)人對該軟件的開發(fā)過程及運(yùn)行環(huán)與所需要的詳細(xì)程度的判斷。 \r\n\r\n5．3．3 文件的擴(kuò)展 \r\n\r\n\r\n　　當(dāng)被開發(fā)系統(tǒng)的規(guī)模非常大（例如源碼超過一百萬行）時，一種文件可以分成幾卷編寫，可以按其。 每一個系統(tǒng)分別編制，也可以按內(nèi)容劃分成多卷，例如：\r\n\r\n\r\n　　項目開發(fā)計劃可能包括：質(zhì)量保證計劃，配置管理計劃， 用戶培訓(xùn)計劃， 安裝實施計劃；\r\n\r\n　　系統(tǒng)設(shè)計說明書可分寫成：系統(tǒng)設(shè)計說明書，子系統(tǒng)設(shè)計說明書； \r\n\r\n　　程序設(shè)計說明書可分寫成：程序設(shè)計說明書，接口設(shè)計說明書，版本說明；\r\n\r\n　　操作手冊可分寫成：操作手冊，安裝實施過程；\r\n\r\n　　測試計劃可分寫成：測試計劃，測試設(shè)計說明， 測試規(guī)程，測試用例；\r\n\r\n　　測試分析報告可分寫成：綜合測試報告，驗收測試報告； \r\n\r\n　　項目開發(fā)總結(jié)報告亦可分寫成項目開發(fā)總結(jié)報告和資源環(huán)境統(tǒng)計。\r\n\r\n5．3．4 節(jié)的擴(kuò)張與縮并\r\n\r\n\r\n　　在有些文件中，可以使用本指南所提供的章、條標(biāo)題，但在條內(nèi)又存在一系列需要分別討論的因素 本指南認(rèn)為，所有的條都可以擴(kuò)展，可以進(jìn)一步細(xì)分，以適應(yīng)實際需要。反之，如果章條中的有些細(xì)節(jié)； 非必需，也可以根據(jù)實際情況縮并。此時章條的編號應(yīng)相應(yīng)地改變。\r\n\r\n5．3．5 程序設(shè)計的表現(xiàn)形式 \r\n\r\n\r\n　　本指南對于程序的設(shè)計表現(xiàn)形式并未作出規(guī)定或限制，可以使用流程圖的形式、判定表的形式，1 可以使用其他表現(xiàn)形式，如程序設(shè)計語言（PDL）、問題分析圖（PAD）等。 \r\n\r\n5．3．6 文件的表現(xiàn)形式 \r\n\r\n\r\n　　本指南對于文件的表現(xiàn)形式亦未作出規(guī)定或限制，可以使用自然語言，也可以使用形式化語言。 5．3．7 文件的其他種類 \r\n\r\n\r\n　　當(dāng)本指南中規(guī)定的文件種類尚不能滿足某些應(yīng)用部門的特殊需要時，他們可以建立一些特殊的文件種類要求，例如軟件質(zhì)量保證計劃、軟件配置管理計劃等，這些要求可以包含在本單位的文件編制實施規(guī)定中。\r\n\r\n6 文件編制的管理工作\r\n\r\n\r\n　　文件編制工作必須有管理工作的配合，才能使所編制的文件真正發(fā)揮它的作用。文件的編制工作實際上貫穿于一項軟件的整個開發(fā)過程，因此，對文件的管理必須貫穿于整個開發(fā)過程。在開發(fā)過程中必須進(jìn)行的管理工作是以下四條。\r\n\r\n6．1文件的形成 \r\n\r\n\r\n　　開發(fā)集體中的每個成員，尤其是項目負(fù)責(zé)人，應(yīng)該認(rèn)識到：文件是軟件產(chǎn)品的必不可少的組成部分；在軟件開發(fā)過程的各個階段中，必須按照規(guī)定及時地完成各種產(chǎn)品文件的編寫工作；必須把在一個開發(fā)步驟中作出的決定和取得的結(jié)果及時地寫入文件；開發(fā)集體必須及時地對這些文件進(jìn)行嚴(yán)格的評審；這些文件的形成是各個階段開發(fā)工作正式完成的標(biāo)志。這些文件上必須有編寫者、評審者和批準(zhǔn)者的簽字，必須有編寫、評審?fù)瓿傻娜掌诤团鷾?zhǔn)的日期。\r\n\r\n6．2文件的分類與標(biāo)識 \r\n　　在軟件開發(fā)的過程中，產(chǎn)生的文件是很多的，為了便于保存、查找、使用和修改，應(yīng)該對文件按層次地加以分類組織。一個軟件開發(fā)單位應(yīng)該建立一個對本單位文件的標(biāo)識方法，使文件的每一頁都具有明確的標(biāo)識。例如可以按如下四個層次對文件加以分類和標(biāo)識。 \r\n\r\n\r\n　　a．文件所屬的項目的標(biāo)識； \r\n　　b．文件種類的標(biāo)識； \r\n　　C．同一種文件的不同版本號；\r\n　　d．頁號。\r\n\r\n\r\n　　此外，對每種文件還應(yīng)根據(jù)項目的性質(zhì)，劃定它們各自的保密級別，確定他們各自的發(fā)行范圍。\r\n\r\n6．3文件的控制 \r\n\r\n\r\n　　在一項軟件的開發(fā)過程中，隨著程序的逐步形成和逐步修改，各種文件亦在不斷地產(chǎn)生、不斷地修改或補(bǔ)充。因此，必須加以周密的控制，以保持文件與程序產(chǎn)品的一致性，保持各種文件之間的一致性和文件的安全性。這種控制表現(xiàn)為： \r\n\r\n\r\n　　a．就從事一項軟件開發(fā)工作的開發(fā)集體而言，應(yīng)設(shè)置一位專職的文件管理人員（接口管理工程師或文件管理員）；在開發(fā)集體中，應(yīng)該集中保管本項目現(xiàn)有全部文件的主文本兩套，由該文件管理人員負(fù)責(zé)保管；\r\n\r\n\r\n　　b．每一份提交給文件管理人員的文件都必須具有編寫人、審核人和批準(zhǔn)人的簽字；\r\n\r\n\r\n　　C．這兩套主文本的內(nèi)容必須完全一致；其中有一套是可供出借的，另一套是絕對不能出借的，以免發(fā)生萬一；可出借的主文本在出借時必須辦理出借手續(xù)，歸還時辦理注銷出借手續(xù)； \r\n\r\n\r\n　　d．開發(fā)集體中的工作人員可以根據(jù)工作的需要，在本項目的開發(fā)過程中持有一些文件，即所謂個人文件，包括為使他完成他承擔(dān)的任務(wù)所需要的文件，以及他在完成任務(wù)過程中所編制的文件；但這種個人文件必須是主文本的復(fù)制品，必須同主文本完全一致，若要修改，必須首先修改主文本；\r\n\r\n\r\n　　e．不同開發(fā)人員所擁有的個人文件通常是主文本的各種子集；所謂子集是指把主文本的各個部分根據(jù)承擔(dān)不同任務(wù)的人員或部門的工作需要加以復(fù)制、組裝而成的若干個文件的集合；文件管理人員。應(yīng)該列出一份不同子集的分發(fā)對象的清單，按照清單及時把文件分發(fā)給有關(guān)人員或部門； \r\n\r\n\r\n　　f．一份文件如果已經(jīng)被另一份新的文件所代替，則原文件應(yīng)該被注銷；文件管理人中要隨時整理主文本，及時反映出文件的變化和增加情況，及時分發(fā)文件；\r\n\r\n\r\n　　g．當(dāng)一個項目的開發(fā)工作臨近結(jié)束時，文件管理人員應(yīng)逐個收回開發(fā)集體內(nèi)每個成員的個人文 件，并檢查這些個人文件的內(nèi)容；經(jīng)驗表明，這些個人文件往往可能比主文本更詳細(xì)，或同主文本的內(nèi)容 有所不同，必須認(rèn)真監(jiān)督有關(guān)人員進(jìn)行修改，使主文本能真正反映實際的開發(fā)結(jié)果。\r\n\r\n6．4文件的修改管理\r\n\r\n\r\n　　在一個項目的開發(fā)過程中的任何時刻，開發(fā)集體內(nèi)的所有成員都可能對開發(fā)工作的已有成果-- 文件，提出進(jìn)行修改的要求。提出修改要求的理由可能是各種各樣的，進(jìn)行修改而引起的影響可能很小， 也可能會牽涉到本項目的很多方面。因此，修改活動的進(jìn)行必須謹(jǐn)慎，必須對修改活動的進(jìn)行加以管理， 必須執(zhí)行修改活動的規(guī)程，使整個修改活動有控制地進(jìn)行。\r\n\r\n\r\n　　修改活動可分如下五個步驟進(jìn)行：\r\n\r\n\r\n　　a．提議開發(fā)集體中的任何一個成員都可以向項目負(fù)責(zé)人提出修改建議，為此應(yīng)該填寫一份修 改建議表，說明修改的內(nèi)容、所修改的文件和部位、以及修改理由；\r\n\r\n\r\n　　b．評議由項目負(fù)責(zé)人或項目負(fù)責(zé)人指定的人員對該修改建議進(jìn)行評議，包括審查該項修改的 必要性、確定這一修改的影響范圍、研究進(jìn)行修改的方法、步驟和實施計劃；\r\n\r\n\r\n　　c．審核一般由項目負(fù)責(zé)人進(jìn)行審核，包括核實修改的自的和要求、核實修改活動將帶來的影 響、審核修改活動計劃是否可行；\r\n\r\n\r\n　　d．批準(zhǔn)在一般情況下，批準(zhǔn)權(quán)屬于該開發(fā)單位的部門負(fù)責(zé)人；在批準(zhǔn)時，主要是決斷修改工作 中各項活動的先后順序及各自的完成日期，以保證整個開發(fā)工作按原定計劃日期完成；\r\n\r\n\r\n　　e．實施由項目負(fù)責(zé)人按照已批準(zhǔn)的修改活動計劃，安排各項修改活動的負(fù)責(zé)人員進(jìn)行修改，建 立修改記錄、產(chǎn)生新的文件以取代原有文件、最后把文件交文件管理人員歸檔，并分發(fā)給有關(guān)的持有者。 \r\n\r\n(To be continued)