什麼是 QA 文檔，我們如何降低其創建和維護成本？

已發表: 2023-08-01

ITRex 的 QA 團隊負責人 Andrii Hilov 撰寫了另一篇文章，討論軟件項目中的質量保證挑戰和陷阱。這次，Andrii 深入研究了 QA 文檔及其在開發高性能軟件中所扮演的角色——按時、按預算、並符合您的業務目標。

以下是他對此的看法。

作為企業軟件開發公司 ITRex 的 QA 團隊負責人，我完全了解客戶希望降低軟件開發成本，同時按時推出功能齊全的產品並實現最大價值。

雖然這些目標是可以理解的，但我建議不要在項目早期解僱您的 QA 團隊，即使他們沒有每天發現錯誤，儘管這似乎是削減薪水和加快軟件發布週期的一個簡單選擇。

此外，我建議您在整個項目中遵循質量保證最佳實踐，以驗證您的解決方案及其所有功能是否按預期運行，並且不會損害您的網絡安全。

其中一種做法是創建和維護適當的質量檢查文檔。

質量保證文件到底是什麼？它如何幫助您從質量保證和測試服務中獲得最大收益？有沒有一種方法可以優化與準備 QA 文檔相關的成本和工作量，同時最大限度地降低開發架構不佳、漏洞百出的應用程序以及必須從頭開始重建整個應用程序的風險？

讓我們來看看吧！

QA 文檔簡介

QA 文檔是質量保證團隊在軟件開發和測試過程中創建和維護的文檔和工件的集合。

它可能包括概述測試策略、測試計劃、測試用例、測試腳本、測試數據、測試日誌、錯誤報告以及與 QA 活動相關的任何其他文檔的各種文檔。這些文檔促進 QA 團隊成員之間的溝通，提供測試指南，並幫助有效地識別和解決問題。

因此，質量保證文檔在確保軟件產品的質量和可靠性方面發揮著至關重要的作用——這也是我們客戶追求的主要目標。

軟件項目中使用哪些質量保證文檔

出於本文的目的，我們將向您簡要概述質量保證文檔，這些文檔構成軟件開發項目中測試文檔的支柱：

測試計劃是一份 QA 文檔，概述了軟件測試活動的總體方法、目標、範圍、資源和時間表。簡單來說，它涵蓋：

項目的名稱和描述，包括正在測試的應用程序類型及其核心功能
首選的測試方法（手動、自動、混合）和測試類型（新功能、集成、兼容性、回歸等）
需要測試的功能以及每個測試活動的大致時間表
最佳團隊構成
測試過程中可能出現的風險和問題概述
您的 QA 團隊將在項目期間使用的測試文檔列表

經驗法則是，當 IT 團隊定義軟件解決方案的功能和非功能需求、選擇適當的技術堆棧和項目管理方法並創建項目路線圖時，在軟件項目開始時編寫測試計劃。

通常需要三天時間來製定和審查沒有測試用例的簡單測試計劃。

測試用例描述了特定的測試場景，包括輸入數據、預期結果和執行步驟。測試用例旨在驗證軟件產品的功能、性能或其他方面。請注意，手動測試服務和 QA 自動化服務團隊都使用測試用例。這樣，您將確保最大的測試覆蓋率，這意味著生產代碼中不會出現任何錯誤。

儘管熟練的 QA 工程師可以在短短 10 分鐘內編寫出高級測試用例，但中型項目的測試用例數量很容易超過 4,000 個（並且還在不斷增加）。 將該數字乘以中級 QA 工程師的平均每小時工資（北美市場每工時 65 美元），您將得到一個令人印象深刻的數字。

檢查表是測試過程中需要完成或驗證的操作或任務的簡明、逐項列表。因此，QA 文檔中的清單通常包括功能模塊、部分、頁面以及應用程序或網絡物理系統中需要 QA 團隊關注的其他元素的完整概要。

在較小的項目中，清單可以成功地取代詳細的測試用例（稍後會詳細介紹）。

測試腳本是使用特定測試工具或框架（例如 Selenium、Appium 和 Cucumber）編寫的代碼塊。這些腳本自動執行測試用例，使測試過程更加高效 - 特別是在大型複雜的軟件項目中，例如多租戶 SaaS 系統和流行的 B2C 應用程序，這些項目更新頻繁，即使是最小的錯誤也可能對用戶體驗產生負面影響。
測試數據是 QA 工程師用來評估軟件解決方案在各種條件下的性能、功能、可靠性和安全性的數據。它可能包括樣本輸入值、邊界條件和各種場景。例如，您的 QA 團隊可能會使用正面和負面測試數據來驗證是否只有正確的登錄憑據才能用於進入軟件系統。同樣，測試數據可用於在某些類型的應用程序中實施年齡限製或調查應用程序如何處理增加的工作負載。
測試日誌記錄測試執行過程，包括測試執行的日期和時間、執行的測試用例的摘要、QA 團隊取得的結果、屏幕截圖以及測試期間注意到的任何問題或觀察結果。測試日誌是跟踪測試進度、識別測試結果的模式或趨勢以及提供測試活動的歷史記錄的重要信息來源。它有助於有效地識別和解決問題，並作為未來測試工作或審核的參考。
缺陷或錯誤報告是詳細說明 QA 活動期間發現的缺陷和問題的測試文檔。具體來說，它們描述了檢測到的錯誤、其嚴重性和優先級，以及缺陷發生的條件。 QA 經理使用錯誤報告將任務分配給軟件測試專家並跟踪他們的狀態。
可追溯性矩陣映射了測試用例和需求或其他工件之間的關係。它有助於確保測試用例充分覆蓋所有需求，允許跟踪整個項目的測試覆蓋率，並消除冗餘的測試活動。
測試完成報告總結了項目中執行的測試活動，包括測試執行狀態、執行的測試用例數量、發現的缺陷以及任何待處理的任務。

為什麼 QA 文檔很重要？

擁有質量保證文檔有助於獲得客戶和軟件工程團隊期望的準確結果。

這是通過多種因素的結合來實現的，包括以下因素：

QA 文檔提供了清晰的說明和指南，軟件測試專家可以遵循這些說明和指南來一致地執行任務，減少變化並提高產品或服務的整體質量。
質量保證文檔減少了在開發過程後期檢測軟件解決方案中關鍵缺陷和錯誤的可能性，從而在預算控制中發揮著關鍵作用。 QA 專家表示，修復 bug 的成本隨著項目的每個階段呈指數級增長，從設計/架構階段的 3 倍到部署階段的 30 倍甚至更多。
質量保證文檔通過簡化審核並提供已建立的流程、程序和質量控制的證據，幫助確保遵守組織必須滿足的監管要求和標準。
通過記錄程序、控制和風險評估流程，軟件測試文檔可以幫助組織識別潛在風險並採取預防措施，以盡量減少其對業務和客戶滿意度的影響。
新員工可以參考您的 QA 文檔來了解軟件項目中的質量流程和程序，從而縮短學習曲線並確保整個組織的培訓一致。
通過記錄不合格情況、糾正措施和經驗教訓，公司可以確定需要改進的領域並實施變革，以提高效率和質量。
擁有記錄良好的質量保證流程和程序可以增強客戶對您公司的產品或服務的信心。廣泛的軟件測試文檔表明了對質量的承諾，並確保組織擁有強大的系統來提供一致和可靠的結果。
在發生法律糾紛或產品召回的情況下，質量保證文檔可以作為重要證據。它可以證明您的組織已遵循既定的質量流程、採取了必要的預防措施並履行了其義務。

創建 QA 文檔需要多長時間？

對這個問題的誠實回答是：“這取決於情況。”

具體來說，時間範圍和相關成本取決於多個因素，例如組織的規模及其流程的複雜性、您所在的行業以及您正在構建的軟件類型。

如果您之前已經開始過軟件開發項目並擁有內部 QA 團隊，那麼您也許能夠在新項目中重用現有的 QA 文檔。使用模板和專用工具來創建和維護軟件測試文檔（例如項目管理和 wiki 軟件）也很有幫助。

您是否始終需要 QA 文檔 - 是否有可能降低其創建和維護成本？

無論多麼有用，質量保證文檔可能會增加軟件項目成本，因為其創建和維護需要額外的工作和人員。

對於資金匱乏的初創企業或在經濟衰退時期進行數字化轉型的企業來說，這可能是一個問題。

那麼，是否每種類型的軟件項目都需要非常詳細的 QA 文檔——是否有可能降低與之相關的成本？

要確定創建 QA 文檔的最佳方法，請考慮以下因素：

項目規模和預算。對於小預算和短期項目（除非我們談論由大型 IT 團隊執行的高度創新和技術項目），無需使文檔流程過於復雜，因此您的 QA 團隊可以選擇清單而不是詳細信息測試用例。至於測試計劃文件，它決定了整體的測試策略，如果沒有預算，或者項目是短期的，不涉及前沿技術，我們也可以不寫。
QA 團隊規模和經驗。項目中的 QA 工程師越多，他們在質量保證方面的經驗越少，控制測試過程的挑戰性就越大。因此，您需要大量的質量保證文檔來使團隊成員保持一致。在這種情況下，建議傾向於測試用例而不是清單，以便根據工程師的經驗和知識更有效地在工程師之間分配任務，並讓更有經驗的 QA 專家（通常每小時工資更高）參與測試用例創建。
項目管理的敏捷與瀑布方法。雖然 ITRex 團隊在這篇博文中總結了敏捷方法和瀑布方法之間的主要區別，但值得一提的是這兩種方法在質量保證方面的不同之處。在 Waterfall 中，軟件測試被保留在最後，這意味著您的 QA 團隊只有在編碼部分 100% 完成時才會進行測試。出於顯而易見的原因，如果沒有適當的質量保證文檔，他們就無法做到這一點，而這些文檔應該在需求獲取階段準備好。在敏捷中，IT 團隊傾向於迭代地構建較小的軟件片段並在每個週期結束時測試代碼，因此不首選預先提供創造性的全面 QA 文檔。儘管如此，我還是建議您編寫一個測試計劃，以便更好地使當前情況與客戶和軟件工程師的期望保持一致。

總的來說，擁有 QA 文檔可以使任何軟件開發項目受益，無論其複雜程度和規模如何。

然而，作為一家以客戶為導向的公司，我們隨時準備根據您的目標和預算提出解決方法。

如果您不確定是否需要為您的項目準備廣泛的質量保證文檔並尋找熟練的 QA 工程師來委託該任務，請聯繫 ITRex！我們將確保您按時、按預算、按規格推出高性能、無錯誤的軟件解決方案！

最初於 2023 年 6 月 30 日發佈於 https://itrexgroup.com。