下面總結一下寫文件需要注意事項：
1）封皮
封面最好是本公司規定的封面，有logo，內容標題，版本號，公司名稱，文件產生日期。（錯誤地方在於，文件的標題要和頁首中的標題一致）
2）修訂歷史
**形式較好些。包括，版本，修訂說明，修訂日期，修訂人，審核時間審核人。（我錯誤的地方在於，**中其他空白**沒有居中）
3）介面資訊
介面呼叫方式，是post方式還是get方式，介面位址，別人需要線上的哪個位址就寫哪個。（自己提前測試好線上的這個介面，是否有其他問題，千萬別犯低階的錯誤，尤其是某個字母寫錯）
4）功能描述
一定要清晰的描述介面功能。（不要遺漏一些細節，比如介面獲取的資訊不包括哪些哪些要寫明白）
5）介面引數說明6）返回值說明
1、有乙個模板返回值，並說明每個返回引數的意義。
2、提供乙個真實的呼叫介面，真實的返回值。
7）介面呼叫限制，介面呼叫安全方面
為了介面安全，我們可以進行md5加密方式，或者自己公司乙個特殊的加密過程，只要雙方採用一致的加密演算法就可以呼叫介面，保證了介面呼叫的安全性。
8）文件全域性方面
文件大標題的字型字型大小一致，小的分標題一致，正文部分字型大小也要一致。文章整體字的類別一致，我認為微軟雅黑字型樣式給人感覺比較清晰。文件目錄，自動生成的目錄會新增些許的修飾，去掉不整齊的部分，得到乙個整齊的目錄格式。
9）文件維護
文件在維護的時候，如有修改一定要寫上修改日期，修改人，對大的修改要有版本號變更。
10）好文件標準檢驗
我認為檢驗乙個文件寫的是否好，主要還是在內容方面。
a.內容是否仔細沒有疏漏之處；
b.是否發給別人使用的時候，無需溝通就能把介面調通；
c.別人通過看文件就能成功的把介面調通，就是乙份好文件。
總結
一些注意事項
0.解題思路 a.普通思路 b.遞迴 bfs dfs c.動態規劃 比遞迴快 d.雙指標 比for迴圈快 如 快慢指標方法 e.用棧 1.陣列初始化 int a new int 5 a 0 預設為0.二維陣列也一樣。boolean b new boolean 5 b 0 預設為false.strin...
有關文件流的一些注意事項
通過給文字設定行高達到垂直居中對齊效果 如下 示例 div在給文字的行高設定為與盒子高度相同時，實現垂直居中效果 在給盒子新增浮動後可以消除縫隙div在很多情況下，盒子不方便給高度，為的是在以後維護的時候繼續新增元素，所以不會把盒子的高度定死，而是通過子盒子本身的高度將父盒子撐大。但是子盒子通常時浮...
php XPATH一些注意事項
40集 建立乙個dom物件並讀取xml檔案到記憶體中 dom new domdocument 1.0 utf 8 dom load book.xml 建立乙個xpath物件 xpath new domxpath dom sql bookstore book 1 title 注意此處路徑數字從1開始，...