怎麼才能寫好技術文件
阿新 • • 發佈:2019-01-08
有很多人都覺得我文件寫的好。這不是一兩個人說了。
我記得大概是在創業工作的時候,從寫業績點文件開始的。那時候,我自己給
做了一套模板。每次都按照這個格式寫。每次都能得到領導的好評。既把自己
的工作都寫進去了,還弄了個好名聲。
在東信工作的時候,我就是軟體組總體設計,專門寫設計文件。寫的還算好。
每個人都覺得寫的還算好。
有朋友說讓我介紹介紹經驗。那我就在這裡說說。其實,世上無難事,是怕
有心人啊。要做好一件事情,只要真心對待總能做好的,下面是關於寫文件
的一點心得。寫出來,以供探討。本文主要討論科技說明文件。不是寫文章。
寫好文件,注意點有:
一、思路清晰、章節分佈合理
分章節、逐層深入地描述問題。這是寫科技文件的要旨。看看MSDN和各家
軟體公司的產品文件就可以知道,無一不是如此。
二、不用口語
科技說明文件,不用口語。不能出現“你們”、“我們”、“好啊”、
“咋樣啊”、“應該”。。。。。。這些都不能出現。比如,“應該”應
寫成“應”、“需”等書面用語。一些討論稿可以適量使用口語。
文件代表公司和技術要點,不是體現個人魅力的地方。一個公司不能使用
五花八門風格的文件。口語的使用,更是會雪上加霜。
三、形成固定風格
科技文件不要求風格各異,但求達意簡約。這個和寫文章的方法是格格不入。
可以針對每類事務,形成固定的模板。所謂有章可循。要把它形成組織積累。
而不是個人行為。這樣能形成整體風格。
四、站在讀者的角度寫
主要涉及到難度、敘述方式等。文件敘述的難易程度要和讀者匹配。否則,
難了看不懂。太簡單了,也沒有意思。這些都沒有起到效果。
五、解決問題是核心
任何文件寫出來都是要解決問題,那就是幫助讀者熟悉知識點。任何的形式、
風格、注意點都是表面的東西。解決問題是關鍵。
一個寫的再好的文件,不能姐姐問題,都是白搭。
六、注意積累
積水成淵、積善成德。任何事情都不是與生俱來的。小孩子出生後,如果馬上
就放到野獸的巢穴,也照樣說不了話。寫好文件也是如此。只有多寫,認真寫
才能寫好。
我記得大概是在創業工作的時候,從寫業績點文件開始的。那時候,我自己給
做了一套模板。每次都按照這個格式寫。每次都能得到領導的好評。既把自己
的工作都寫進去了,還弄了個好名聲。
在東信工作的時候,我就是軟體組總體設計,專門寫設計文件。寫的還算好。
每個人都覺得寫的還算好。
有朋友說讓我介紹介紹經驗。那我就在這裡說說。其實,世上無難事,是怕
有心人啊。要做好一件事情,只要真心對待總能做好的,下面是關於寫文件
的一點心得。寫出來,以供探討。本文主要討論科技說明文件。不是寫文章。
寫好文件,注意點有:
一、思路清晰、章節分佈合理
分章節、逐層深入地描述問題。這是寫科技文件的要旨。看看MSDN和各家
軟體公司的產品文件就可以知道,無一不是如此。
二、不用口語
科技說明文件,不用口語。不能出現“你們”、“我們”、“好啊”、
“咋樣啊”、“應該”。。。。。。這些都不能出現。比如,“應該”應
寫成“應”、“需”等書面用語。一些討論稿可以適量使用口語。
文件代表公司和技術要點,不是體現個人魅力的地方。一個公司不能使用
五花八門風格的文件。口語的使用,更是會雪上加霜。
三、形成固定風格
科技文件不要求風格各異,但求達意簡約。這個和寫文章的方法是格格不入。
可以針對每類事務,形成固定的模板。所謂有章可循。要把它形成組織積累。
而不是個人行為。這樣能形成整體風格。
四、站在讀者的角度寫
主要涉及到難度、敘述方式等。文件敘述的難易程度要和讀者匹配。否則,
難了看不懂。太簡單了,也沒有意思。這些都沒有起到效果。
五、解決問題是核心
任何文件寫出來都是要解決問題,那就是幫助讀者熟悉知識點。任何的形式、
風格、注意點都是表面的東西。解決問題是關鍵。
一個寫的再好的文件,不能姐姐問題,都是白搭。
六、注意積累
積水成淵、積善成德。任何事情都不是與生俱來的。小孩子出生後,如果馬上
就放到野獸的巢穴,也照樣說不了話。寫好文件也是如此。只有多寫,認真寫
才能寫好。