闡述一個公司文檔管理的重要性


1          概述

文檔測試規范作為后續項目的重要產出物,除提供涉及功能服務外,同時需要配套相應文檔,且文檔必須測試通過。

2   目的

規范管理文檔,讓文檔成為標准化的工具。

1、指導新進員工快速接手工作,防止技術流失。

2、讓文檔成為唯一約束,尤其是集成項目,多服務器配置部署必須達成一致。

3、好的文檔能達到提高易用性、提高可靠性、降低技術支持費用的目的,從而提高了產品的整

體質量。用戶通過文檔可以掌握具體的使用方法,這提高了產品的易用性,避免了用戶在摸索

使用中一些不可預期的操作,也就相對避免了一些不可預期的錯誤的發生,從而提高了產品的

可靠性。

4、文檔在軟件開發人員,軟件管理人員,維護人員,軟件測試人員以及計算機之間起到了多種

橋梁作用。軟件開發人員在各個階段中以文檔作為前階段工作成果的體現和后階段工作的依據,

這個作用是顯而易見的。軟件開發過程中軟件開發人員需制定一些工作計划或工作報告,這些

計划和報告都要提供給管理人員,並得到必要的支持。管理人員則可通過這些文檔了解軟件開

發項目安排,進度,資源使用和成果等。軟件開發人員需為用戶了解軟件的使用,操作和維護

提供詳細的資料,我們稱此為用戶文檔。

3          角色及職責定義

1)     產品:根據文檔規范,負責需求文檔的編寫和維護工作。

2)     研發:根據文檔規范,負責操作文檔和研發項目文檔的編寫和維護工作。

3)     測試:根據文檔規范,負責測試項目文檔的編寫和維護工作。

      根據文檔規范,負責對需求文檔、操作文檔和測試項目文檔的測試工作。

4          文檔收集和歸類

文檔測試分為三大類:

需求文檔:

1)     軟件需求說明書(也稱軟件規格說明書,其中對所開發軟件的功能,性能,用戶界面

及運行環境等作出詳細的說明。它是用戶與開發人員雙方對軟件需求取得共同理解

基礎上達成的協議,也是實施開發工作的基礎)。

操作文檔:

1)     軟件安裝文檔

2)     系統部署文檔

項目文檔:

1)     研發項目文檔:

a)     項目開發計划(為軟件項目實施方案制定出具體計划,應該包括各部分工作的負責人

員,開發的進度,開發經費的預算,所需的硬件及軟件資源等。項目

開發計划應提供給管理部門,並作為開發階段評審的參考)。

b)     開發進度月報(及時向有關管理部門匯報項目開發的進展和情況,以便及時發現或處

理開發過程中的問題。一般地,開發進度月報以項目組為單位每月編

寫的。如果被開發的軟件系統規模比較大,整個工程項目被划分給若

干個分項目組分擔,開發進度月報以項目組為單位按月編寫)。

c)     開發總結報告(總結本軟件的開發經驗和總結所學到的知識,以及對一個系統的大型

的軟件設計的總體感悟,並將軟件設計過程中遇到的問題加以闡述和

說明)。

d)     數據庫設計說明書(該說明書是對於設計中的數據庫的所有標識.邏輯結構和物理結

構做出具體的設計規定)。

e)     概要設計說明書(該說明書是概要設計階段的工作成果,它應說明功能分配,模塊划

分,程序的總體結構,輸入輸出以及接口設計,運行設計,數據結

構設計和出錯處理設計等,為詳細設計奠定基礎)。

f)      詳細設計說明書(着重描述每一模塊是怎樣實現的,包括實現算法,邏輯流程等)。

g)     可行性研究報告(說明該軟件開發項目的實現在技術上,經濟上和社會因素上的可行

性,評述為了合理地達到開發目標可供選擇的各種可能實施的方案,

說明並論證所選定實施方案的理由)。

2)     測試項目文檔:

a)     測試計划(描述了要進行的測試活動的范圍、方法、資源和進度的文檔;是對整個信

息系統應用軟件組裝測試和確認測試。文檔中確定測試項、被測特性、測

試任務、誰執行任務、各種可能的風險)。

b)     測試報告(把測試的過程和結果寫成文檔,對發現的問題和缺陷進行分析,為糾正軟

件的存在的質量問題提供依據,同時為軟件驗收和交付打下基礎)。

c)     測試用例(指對一項特定的軟件產品進行測試任務的描述,體現測試方案、方法、技

術和策略。內容包括測試目標,測試環境,輸入數據,測試步驟,預期結

果,測試腳本等並形成文檔)。

4.1  文檔測試邊界

4.1.1 需求文檔

1)     准確地按照文檔的描述使用軟件。

2)     嘗試每一個功能點。

3)     檢查每條陳述。

4)     查找容易誤導用戶的內容。

4.1.2 操作文檔

微信掃描二維碼查看更多資訊!


免責聲明!

本站轉載的文章為個人學習借鑒使用,本站對版權不負任何法律責任。如果侵犯了您的隱私權益,請聯系本站郵箱yoyou2525@163.com刪除。



 
粵ICP備18138465號   © 2018-2025 CODEPRJ.COM