為了使軟體文件能起到前節所提到的多種橋梁作用，使它有 助於程式設計師編制程式，有助於管理人員監督和管理軟體開發，有助 於使用者了解軟體的工作和應做的操作，有助於維護人員進行有效 的修改和擴充，文件的編制必須保證一定的質量。質量差的軟體文 檔不僅使讀者難於理解，給使用者造成許多不便，而且會削弱對 軟體的管理(管理人員難以確認和評價開發工作的進展)，增高軟 件的成本(一些工作可能被迫返工)，甚至造成更加有害的後果(如誤操作等)。
造成軟體文件質量不高的原因可能是：
·缺乏實踐經驗，缺乏評價文件質量的標準。
·不重視文件編寫工作或是對文件編寫工作的安排不恰當。
最常見到的情況是，軟體開發過程中不能按表5給出的進度， 分階段及·時完成文件的編制工作，而是在開發工作接近完成時集 中人力和時間專門編寫文件。另一方面，和程式工作相比，許多 人對編制文件不感興趣。於是在程式工作完成以後，不得不應付 一下，把要求提供的文件趕寫出來。這樣的做法不可能得到高質 量的文件。實際上，要得到真正高質量的文件並不容易，除去應在 認識上對文件工作給予足夠的重視外，常常需要經過編寫初稿， 聽取意見進行修改，甚至要經過重新改寫的過程。
①針對性；文件編制以前應分清讀者物件，按不同的型別、不 同層次的讀者，決定怎樣適應他們的需要。例如，管理文件主要是 面向管理人員的，使用者文件主要是面向使用者的，這兩類文件不應 像開發文件(面向軟體開發人員)那樣過多地使用軟體的專業術語。
②精確性：文件的行文應當十分確切，不能出現多義性的描 述。同一課題若干文件內容應該協調一致，應是沒矛盾的。
⑧清晰性：文件編寫應力求簡明，如有可能，配以適當的圖 表，以增強其清晰性。
④完整性：任何乙個文件都應當是完整的、獨立的，它應自成 體系。例如，前言部分應作一般性介紹，正文給出中心內容，必要 時還有附錄，列出參考資料等。同一課題的幾個文件之間可能有些 部分相同，這些重複是必要的。例如，同一專案的使用者手冊和操作 手冊中關於本專案功能、效能、實現環境等方面的描述是沒有差別 的。特別要避免在文件**現轉引其它文件內容的情況。比如，一 些段落並未具體描述，而用「見××文件××節」的方式，這將給 讀者帶來許多不便。
⑤靈活性：各個不同的軟體專案，其規模和複雜程度有著許 多實際差別，不能一律看待。圖6所列文件是針對中等規模 的軟體而言的。對於較小的或比較簡單的專案，可做適當調整或合 並。比如，可將使用者手冊和操作手冊合併成使用者操作手冊；軟體需 求說明書可包括對資料的要求，從而去掉資料要求說明書；概要設 計說明書與詳細設計說明書合併成軟體設計說明書等。
⑥可追溯性；由於各開發階段編制的文件與各階段完成的工 作有著緊密的關係，前後兩個階段生成的文件，隨著開發工作的逐 步擴充套件，具有一定的繼承關係。在乙個專案各開發階段之間提供的 文件必定存在著可追溯的關係。例如，某一項軟體需求，必定在設 計說明書，測試計畫以至使用者手冊中有所體現。必要時應能做到 跟蹤追查。
檢驗試驗計畫（卡）的編制要求
1.檢驗試驗計畫 卡 1 它是質量計畫 施工方案 中的一項重要內容，是整個工程專案施工過程中質量檢驗的指導性檔案，是施工和質量檢驗人員執行檢驗和試驗操作的依據。2 在檢驗試驗計畫 卡 中明確給出工序質量檢驗一般包括的內容，如標準 度量 比較 判定處理和記錄等。2.檢驗試驗計畫的編制依據和主要內容 1...
有關文件編寫的要求
奇數頁碼在右下 偶數頁碼在左下。1 文體和術語應保持統一 2 結構及章 條的編號應盡可能相同 3 類似的意思應用類似的表達 4 相同額度意思應用相同的表達 5 同乙個概念應使用同乙個術語並盡可能唯一 章使用阿拉伯數字從1開始對章編號，從範圍開始，一直連續到附錄之前 乙個層次中有兩個或者兩個以上的條時...
概要設計文件要求
1 引言 1 1編寫目的 說明編寫這份概要設計說明書的目的，指出預期的讀者。1 2背景 說明 a 待開發軟體系統的名稱 b 列出此專案的任務提出者 開發者 使用者以及將執行該軟體的計算站 中心 1 3定義 列出本檔案中用到的專門術語的定義和外文首字母組詞的原片語。1 4參考資料 列出有關的參考檔案，...