it軟件項目文檔管理-文庫吧資料
2025-01-16 00:02本頁面
【正文】 義的；對于非正式的文檔，其識別標(biāo)準(zhǔn)可以由項目經(jīng)理來定義。 包括： 文檔標(biāo)準(zhǔn)是保證文檔質(zhì)量的基礎(chǔ)，根據(jù)一定的標(biāo)準(zhǔn)編寫文檔，可以有一致的外觀、結(jié)構(gòu)和質(zhì)量等。 ? 交互標(biāo)準(zhǔn)： 通過電子郵件和文檔數(shù)據(jù)庫交換文檔變得越來越重要 ， 交互標(biāo)準(zhǔn)使得所有的文檔都存在可比性 。 ? 產(chǎn)品標(biāo)準(zhǔn)： 這種標(biāo)準(zhǔn)操縱文檔本身 。 ? 文檔的結(jié)構(gòu)通常應(yīng)當(dāng)是嚴(yán)整的，并且有一定的標(biāo)準(zhǔn)。 ? 如果文檔包括許多細(xì)節(jié)性參考信息，應(yīng)該有附錄。 如圖 。 ? 維護(hù)指導(dǎo)文檔 ， 主要描述系統(tǒng)已知的問題 、 軟件支持 、 硬件支持等信息 ， 以便維護(hù)時使用 。 這些列表包括程序注釋 、 用來解釋代碼中復(fù)雜代碼段和采用的編碼方法等 。 ? 每個子系統(tǒng)的規(guī)范和設(shè)計說明書 。 ? 系統(tǒng)體系結(jié)構(gòu)文檔 。 2022/2/6 遼寧工程技術(shù)大學(xué) 軟件學(xué)院 10 產(chǎn)品文檔（ 4） —— 系統(tǒng) 文檔 ? 系統(tǒng)文檔包括所有描述系統(tǒng)是如何從需求報告到最終變成可接受的系統(tǒng)過程中 ， 與分析 、 設(shè)計 、 實施等方面有關(guān)的技術(shù)文檔 。 ? 系統(tǒng)安裝文檔 ：一般面向系統(tǒng)管理員 ， 為系統(tǒng)管理員提供在特定環(huán)境下如何安裝系統(tǒng)的詳細(xì)說明 。 ? 系統(tǒng)參考手冊 ：描述系統(tǒng)的功能設(shè)施及其用途 ， 能為錯誤信息提供一個完整的列表 ， 并且描述怎樣從發(fā)現(xiàn)的錯誤中恢復(fù) 。 用戶通過閱讀該文檔 ，可以確定是不是他們所需要的系統(tǒng) 。 2022/2/6 遼寧工程技術(shù)大學(xué) 軟件學(xué)院 8 產(chǎn)品文檔（ 2） 系統(tǒng)管理員向?qū)? 系統(tǒng)評估員 功能性描述 描述提供 的服務(wù) 系統(tǒng)管理員 安裝描述 怎樣安 裝系統(tǒng) 新用戶 初級使用手冊 如何開始 使用系統(tǒng) 老用戶 參考手冊 所有系統(tǒng)功能 的詳細(xì)描述 系統(tǒng)管理員 如何操作和 維護(hù)系統(tǒng) 圖 需要隨軟件系統(tǒng)發(fā)布而產(chǎn)生的部分用戶文檔 2022/2/6 遼寧工程技術(shù)大學(xué) 軟件學(xué)院 9 產(chǎn)品文檔（ 3） —— 用戶文檔 ? 系統(tǒng)功能描述 ：簡要描述系統(tǒng)的需求和提供的服務(wù) 。他們只關(guān)心如何利用軟件來幫助他們完成工作，不關(guān)心計算機和軟件管理上其他細(xì)節(jié)。 ? 在軟件項目中，軟件的用戶并不完全相同，不同用戶面向的文檔也不一樣，因此，在編輯文檔時，必須將最終用戶和系統(tǒng)管理員區(qū)分開。 2022/2/6 遼寧工程技術(shù)大學(xué) 軟件學(xué)院 7 產(chǎn)品文檔（ 1） ? 產(chǎn)品文檔主要描述已交付的軟件產(chǎn)品情況，與大多數(shù)過程文檔不同，產(chǎn)品文檔有很長的生命周期，它必須隨著產(chǎn)品一步步發(fā)展。 ? 在過程文檔中 ， 計劃可以是由周計劃 、 日計劃或月計劃組成 ， 進(jìn)度一般以周為單位進(jìn)行報告 ， 記錄軟件工程師的想法和目的備忘錄將不斷被改變 。 過程文檔可以分為如下幾類： 2022/2/6 遼寧工程技術(shù)大學(xué) 軟件學(xué)院 6 過程文檔（ 2） ? 過程文檔的 最大特點 是：大部分文檔都是已經(jīng)過時了的 。 ? 工作文檔 ：這些文檔是在項目開發(fā)中最主要的交流溝通工具 ， 記錄了軟件項目開發(fā)中軟件工程師的想法等 。 ? 相關(guān)報告 ：這些文檔用來報告在軟件開發(fā)過程中 ， 資源是如何分配和利用的 。不同時期編寫的文檔代表在軟件開發(fā)過程中的一個重要階段里程碑。 ? 編寫過程文檔的主要目的在于所開發(fā)的產(chǎn)品能被很好地管理。 ? 產(chǎn)品文檔： 是那些描述正在開發(fā)的產(chǎn)品的資料。 ? 一般：文檔數(shù)量的多少、規(guī)模的大小、結(jié)構(gòu)的復(fù)雜程度與所開發(fā)軟件的大小和復(fù)雜程度成正比。 與軟件項目相關(guān)的項目文檔的概念屬性有 ： ? 軟件項目文檔是 IT軟件項目開發(fā)中的重要組成部分。 ? 能為項目管理者提供項目計劃、預(yù)算、開發(fā)進(jìn)度等各方面的信息。2022/2/6 遼寧工程技術(shù)大學(xué) 軟件學(xué)院 1 第 10章 IT軟件項目文檔管理
公司管理相關(guān)推薦
鄂ICP備17016276號-1