工程師文件編寫注意事項
1.重要文件避免簡稱的出現,一定要使用全稱;
2.文件輸出物件決定編寫方式,如果文件是寫給運維同事,那麼步驟一定要一步一步清晰有序有條理,換位思考讓人看明白;
3.寫完文件要更新整個目錄的域;
4.寫完文件要檢查頁首、頁尾的文字是否與交付專案對應;
5.檔名稱或標題中,涉及英文字母的注意當大寫時一定大寫。
工程師文件編寫注意事項
1.重要文件避免簡稱的出現,一定要使用全稱;
2.文件輸出物件決定編寫方式,如果文件是寫給運維同事,那麼步驟一定要一步一步清晰有序有條理,換位思考讓人看明白;
3.寫完文件要更新整個目錄的域;
4.寫完文件要檢查頁首、頁尾的文字是否與交付專案對應;
5.檔名稱或標題中,涉及英文字母的注意當大寫時一定大寫。