posts - 10,comments - 2,trackbacks - 0
           

          1 針對性

           文檔編制以前應分清讀者對象,按不同的類型、不同層次的讀者,決定怎樣適應他們的需要。    

             ① 對于面向管理人員和用戶的文檔,不應像開發(fā)文檔(面向軟件開發(fā)人員)那樣過多地使用軟件的專業(yè)術語。 難以避免使用的詞匯,應在文檔中添加詞匯表,進行解釋。    

             ② 開發(fā)文檔使用的專業(yè)詞匯未被廣泛認知的,應添加注釋進行說明。

             ③ 縮寫詞未被廣泛認知的,應在其后跟上完整的拼寫。    
                  

          2  正確性 

              沒有錯字,漏字。

              文檔間引用關系正確。 

              文檔細節(jié)(Title/History)正確。    
                  
          3  
          準確性

              意思表達準確清晰沒有二義性。

              正確使用標點符號避免產生歧義。    
                  
          4  
          完整性 

              意思表達完整,能找到主語、謂語、賓語,沒有省略主語,特別是謂語。

              一句話中不能出現(xiàn)幾個動詞一個賓語的現(xiàn)象。

              不遺漏要求和必需的信息。    
                  
          5  
          簡潔性 

              盡量不要采用較長的句子來描述,無法避免時,應注意使用正確的標點符號。

              簡潔明了,不累贅冗余,每個意思只在文檔中表達一次。  

              每個陳述語句,只表達一個意思。    

              力求簡明,如有可能,配以適當?shù)膱D表,以增強其清晰性。    
                  
          6  
          統(tǒng)一性 

              統(tǒng)一采用專業(yè)術語和項目規(guī)定的術語集。

              同一個意思和名稱,前后描述的用語要一致。 

              文檔前后使用的字體要統(tǒng)一。    

              同一課題若干文檔內容應該協(xié)調一致,沒有矛盾。    
                  
          7  
          易讀性 

              文字描述要通俗易懂。 

              前后文關聯(lián)詞使用恰當。  

              文檔變更內容用其他顏色與上個版本區(qū)別開來。 

              測試步驟要采用列表的方式,用1)2)3)…等數(shù)字序號標注。 

           

          posted on 2007-05-27 08:21 CHUANDAOJUN 閱讀(886) 評論(0)  編輯  收藏 所屬分類: 開發(fā)文檔

          只有注冊用戶登錄后才能發(fā)表評論。


          網站導航:
           
          主站蜘蛛池模板: 霸州市| 海南省| 仪征市| 长沙市| 龙游县| 井陉县| 罗山县| 山东| 福州市| 新平| 澳门| 黑山县| 金塔县| 昌江| 宜良县| 班戈县| 桂林市| 温州市| 彭阳县| 平利县| 兴义市| 新巴尔虎左旗| 扶沟县| 浑源县| 盐源县| 湖口县| 旬阳县| 平陆县| 禄丰县| 勃利县| 宾阳县| 乌鲁木齐县| 弥渡县| 通州区| 横峰县| 内黄县| 舟曲县| 武山县| 星座| 湾仔区| 丰宁|