完備性，正確性，一致性，易理解性
完備性：使用者文件應包含產品使用所需要的全部資訊：（包括使用者可呼叫的所有功能；所有邊界值；如果安裝能由使用者來完成，則使用者文件應包括安裝手冊；如果維護能由使用者來完成，則使用者文件應包括程式維護手冊）；
使用軟體必須資訊的檢查：檢查使用者文件集中是否包含使用該軟體的必須資訊。
功能完整性：檢查使用者文件集中是否包含所有功能以及終端使用者能使用的功能。
備份及恢復指南： 檢查使用者文件集中是否對系統備份方法及恢復方法進行描述。
安裝環境的要求：檢查使用者文件集中是否陳述了安裝該軟體所要求的最小和最大磁碟空間。
分段是否清晰： 如果使用者文件集分若干部分，檢查是否標識出所有部分。
正確性：使用者文件中所有資訊應是正確的，不能有歧義和錯誤的表達
使用者文件集資訊正確性：檢查使用者文件集中的資訊是否為委託方提供。
二義性：檢查使用者文件集中的資訊是否存在歧義。
一致性：使用者文件自身內容或相互之間以及與軟體系統之間都不應相互矛盾。每個術語的含義宜處處保持一致，應保持95%的一致性；
一致性檢查：檢查使用者文件集是否自相矛盾、互相矛盾。
易理解性：使用者文件對於正常執行其工作任務的一般使用者宜是易理解的；使用者文件應條理清晰、功能模組明確、功能描敘詳細易懂；
術語文體檢查：使用者文件集中的文體是否便於使用者理解。
文件清單檢查：檢查是否有文件清單。
來自為知筆記(wiz)
Jenkins 使用者文件（部署）
最基本的持續交付管道至少有三個階段，應該在jenkinsfile中定義 build test和deploy，對於本節，我們將主要關注部署階段，但應注意穩定的構建和測試階段是任何部署活動的重要前提。jenkinsfile declarative pipeline pipeline stage test...
git使用者文件1 git基礎
1.1 分布式 我們把遠端倉庫 雲端的倉庫 稱為repo，repo必須有乙個master分支，就是主分支。repo除了有乙個master分支，還有很多其他的分支，若干個分支之間儲存的資料一版都是不一樣的 本地可以git clone下來repo的master分支，也可以git clone下來repo的...
寫使用者文件的三把利器
好久沒來51cto寫文章了,原因是最近換了份job,很少做運維方面的工作,不過沒問題,這不影響我對51cto的熱愛,今天為大家帶來 寫使用者文件的三把利器 呵呵,最近在製作大量的使用者文件時發現,需要加入很多 並茂說明,而在製作過程中,有趣的能增強文件的閱讀性,所謂 看圖說話 嘛,廢話少說,進入主題...