[list]
[*]寫作目的：使維護人員通過該手冊能夠正確對系統進行維護，在維護中，盡可能的不要走彎 路，不要因為某些操作失誤而導致重新操作，這些注意事項都需要表達清楚，整個文件應該描述清楚。不能有模稜兩可的地方。
[/list]
[list]
[*]寫作方法：考慮該模組與其它模組之間的關係（涉及到寫作的順序，寫作的配合），盡可能的是乙個子模組（該子模組涉及到多個功能點，而這些功能點之間是有依賴關係的）的寫作，由同乙個人完成。
[*]
[/list]
[*] [list]
[*]盡可能的考慮到使用者在操作某一步驟時，會出現哪些錯誤，應該怎麼規避。例如：檔名必須以***結尾
[/list]
[*] [list]
[*]區分管理人員與維護人員之間的差異性，認真體會這些人員的要求，即從使用者的角度來思考問題
[/list]
[*] [list]
[*] 不宜過多過大，這不是安裝手冊。
[/list]
[*] [list]
[*]比較複雜的事例，可以通過舉例來進行描述
[/list]
[*] [list]
[*]最好是由開發人員與使用者進行結對寫該文件
[/list]
[*] [list]
[*]在涉及到使用者名稱的地方，最好使用「張三」、「李四」來代替，而不是使用「yanliebing」這樣的使用者名稱
[/list]
[*] [list]
[*]在涉及到上下級使用者（部門等）、需要說明此處是直屬上級使用者還是所有上級使用者
[/list]
在每一次文件評審後，都需要總結，否則很容易忘記。而且自己需要理解該文件在整個系統中的作用。 [color=red]思考[/color]
暫時想到這麼多了！！！
軟工文件」注意注意「事項
當然更建議大家用onenote。主要說一下，寫軟工文件我遇到的問題。1.首先是文件的命名問題，咱們手裡的資料是有名字的，但是那只是乙個模板的名字，我們寫文件嚴格的命名規範不僅要有文件名字，還要有編輯日期和編寫人的名字。2.操作手冊和使用者手冊，首先解釋這兩個是什麼。操作手冊是安裝的過程，使用者手冊是...
Scala API文件檢視注意事項
注意 初學者建議 1.www.scala lang.org api在現瀏覽scaladoc 2.檢視文件時，每個類旁邊的c和o會連線到對應的類 c 或者伴生物件 o 3.使用數字型別，檢視richint richdouble等，使用字串檢視stringops 4.數學函式位於scala.math.包...
資料庫維護注意事項
壓縮日誌及資料庫檔案大小 特別注意 請按步驟進行,未進行前面的步驟,請不要做後面的步驟 否則可能損壞你的資料庫.一般不建議做第4,6兩步 第4步不安全,有可能損壞資料庫或丟失資料 第6步如果日誌達到上限,則以後的資料庫處理會失敗,在清理日誌後才能恢復.1.清空日誌 dump transaction ...