軟體文檔寫作與管理

前言

軟體文檔隨著軟體的產生而產生，隨著軟體工程的提出和發展而不斷得到規範，並且軟體文檔也成為軟體工程各個階段里程碑的重要標誌之一。但在實際軟體開發過程中，由於人為因素以及時間和成本的限制，導致軟體文檔資料通常既不完整也不合格，進而對軟體開發和後期維護造成影響。

本書旨在將軟體工程的基礎理論、實踐和文檔寫作緊密結合，以提供一個統一分層的軟體文檔寫作體系；將有關軟體工程理論、軟體文檔寫作方法的敘述、分析和套用有機地結合，使之形成一個較完整的軟體文檔寫作方法體系；對軟體文檔管理給予系統的介紹，從而充實和豐富傳統的軟體文檔寫作。

本書是作者十多年來從事軟體工程教學、理論與實踐研究的學習心得和工作總結，且匯入了一些企業的軟體文檔規範和閱讀國內外大量相關著作和論文的體會。它以分析的觀點、實踐的角度，站在開發與套用的立場來進行討論，希望不僅說明軟體文檔“是什麼”，還進一步分析“為什麼”，且討論“如何做”，使讀者不僅能“知其然”，還能“知其所以然”，懂得“如何套用”。它不僅包括了軟體工程各個階段的文檔，還從質量保證和配置管理的角度說明對文檔的管理。

全書共分10章，第1章介紹軟體工程基礎以及軟體文檔和軟體過程之間的關係；第2章介紹項目規劃類文檔寫作，包括商業計畫書、可行性研究報告、項目方案書和項目開發計畫等；第3章介紹需求類文檔寫作，主要涉及需求規格說明書；第4章介紹設計類文檔寫作，包括架構文檔、概要設計說明書、詳細設計說明書、資料庫設計說明書和界面設計文檔等；第5章介紹測試類文檔寫作，包括測試用例、測試計畫和測試分析報告；第6章介紹項目結束類文檔，包括用戶培訓計畫、用戶手冊、產品手冊和項目總結報告等；第7章介紹項目管理過程類文檔，包括項目風險管理、時間進度管理、估算管理和項目的月報與周報等；第8章介紹質量保證相關文檔；第9章介紹軟體文檔配置管理的方案，對軟體文檔進行版本控制；第10章介紹企業軟體文檔的管理；最後是附錄，給出了若干軟體文檔的模板供讀者參考。

本書在編寫過程中力求語言通俗易懂，文字簡潔明了，便於自學者閱讀，除可作為高校計算機專業和軟體工程專業的教材外，也可供從事計算機工作的工程技術人員及其他自學者參考。本書的手稿已在軟體學院對本科生和研究生講授了多次，他們有的閱讀了原講義，並提出過意見。

對於書中的許多內容，作者的多屆研究生、本科生曾從各個不同的方面、以不同的形式做了許多工作。在此，一併向他們表示誠摯的謝意。

內容簡介

社會的發展對軟體工程師提出了越來越高的要求，不僅要求他們具備良好的知識背景、較強的動手能力，還要求他們具有很好的溝通與表達能力。從培養和訓練軟體工程師的書面溝通能力這一主旨出發，本書介紹了軟體技術文檔撰寫的基本原則、常用的文檔類型，以及收集信息和書寫文檔的策略，以便使讀者能按照標準的格式恰當地使用表格、圖和參考文獻等，書寫出清晰、簡明和準確的技術文檔和個人總結，並能評審書面文檔以發現各種問題。本書要求讀者具備一定的軟體工程知識。

軟體文檔寫作與管理

基本介紹

前言

內容簡介

相關詞條

熱門詞條