|
最近一段時間，經常與PPT文件為伍，開會的時候也是較多的涉及文件，因此有了一些來來回回的修改，此篇做一些整理，作為以后寫類似文檔的參考。 1. 區分對象 個人感覺，最大的問題其實是區分說明文件的受眾。基本上，類似于我們這一級的工程師，是需要把自己面臨的技術問題，以較為通俗化的描述方式反饋給我們的技術“老大”，而“老大”獲取這份文件，往往并不是終點，還得進行上一層的傳遞和表達。某些時候，這些文件，也是需要給客戶的工程師或者他的Boss，來說明某某事情的問題。 因此，寫此類報告，往往需要有幾點要求： a. 足夠短，足夠精悍 因為越往上，可能花在此事情的時間越短，所以得花較短的篇幅，花其中最重要的點表達出來。 b. 足夠的背景說明與輔助文件 文件需要保證能夠在不補充的情況下，沒有基本知識背景的條件下，能夠有75%以上的認知。而需要工程師自己準備一些說明材料，以最短的時間，大概整理給老板，以便于其向上整理。 c. 每個詞精確 已經有幾任老大都覺得這是必要的，在本身篇幅較短的時候，用詞不準將會導致歧義等，將會使得事情變得非常糟糕。所以在做完內容，經過若干檢查后，對文辭的檢查是非常重要的；需要特別注意的，還是基本英語的學習，雖然大多數人都似乎關注口語的表達，但寫個簡單的文檔漏洞百出，結局會更慘。而且在小會議廳里頭，老板找你逐字逐句幫你挑錯誤，是何等的尷尬啊尷尬。 2. 實際操作中的準備 在實際操作中，往往都是接到一個任務，比如老板希望把你某段時間中所遇到的問題，以及某個項目中的Issue，以總結的概念整理出來。往往是作為其概述的一部分，因此需要注意幾點： a.確定內容和范圍 與其在交代不清的前提下，死命整理材料，然后收獲糟糕的評價，還不如耐著性子，把要求仔細的分辨出來。這里就存在內容損耗和偏好問題，在確認足夠的清楚的條件下，整個文件最終的誤差會在許可的范圍內，或者可以經過較小的修正就可以完成了。 b.屏蔽技術細節 我經常犯的一個錯誤，就像寫博文一樣，把足夠多的細節都整理出來了。腦海之中的問題，往往是個人的思維結果，一般而言，旁人是需要花很多的時間去學習的，特別是離細節較遠的老大們。這里就需要做足夠的功課，把技術的細節，以一種相對易懂的方式整理出來。目前理解的時間分配，可能需要60分鐘準備基礎材料，得花更多的時間進行加工，最后檢查也要留有足夠的時間。 寫這篇的內容，主要是自己這段時間確實做得有些糟糕。從思想上，從技術上都受到了很大的打擊，可能工程師們總以為說明的事情是相對容易和幼稚的活，但是糟糕的表達和溝通，基本就限制了項目的效率。 文章寫到這里有些亂，先作為初稿吧。 |
