很多人說，不知道怎麼寫文件，都是憑著感覺寫。
網上也很少有資料，教你寫文件。這已經影響了中文軟體的發展。
英語世界裡，文件非常受重視，許多公司和組織都有自己的文件規範，清楚地規定寫作要求，比如微軟、MailChimp、Apple、Yahoo、docker、Struts 等等（維基百科有一份完整的清單）。中文的也有不少，但都不令人滿意，要麼太簡單，要麼不太適用。
我就動手，參考上面的規範，也結合自己的實踐，總結了一份簡單的《中文技術文件的寫作規範》。
我希望，這樣可以拋磚引玉，讓更多人重視文件，進而真正出現大家普遍接受的文件規範。
下面是關於寫作風格的一個片段。歡迎提交 Issue 和 PR 補充。
=================================
寫作風格
（摘自《中文技術文件的寫作規範》）
如果使用了被動語態，應考慮更改為主動語態。
錯誤：假如此軟體尚未被安裝， 正確：假如尚未安裝這個軟體，
不使用非正式的語言風格。
錯誤：Lady Gaga 的演唱會真是酷斃了，從沒看過這麼給力的表演！！！ 正確：無法參加本次活動，我深感遺憾。
用對"的"、"地"、"得"。
她露出了開心的笑容。 （形容詞＋的＋名詞） 她開心地笑了。 （副詞＋地＋動詞） 她笑得很開心。 （動詞＋得＋副詞）
使用代詞時（比如"其"、"該"、"此"、"這"等詞），必須明確指代的內容，保證只有一個含義。
錯誤：從管理系統可以監視中繼系統和受其直接控制的分配系統。 正確：從管理系統可以監視兩個系統：中繼系統和受中繼系統直接控制的分配系統。
名詞前不要使用過多的形式詞。
錯誤：此裝置的使用必須在接受過本公司舉辦的正式的裝置培訓的技師的指導下進行。 正確：此裝置必須在技師的指導下使用，且指導技師必須接受過由本公司舉辦的正式裝置培訓。
句子的長度儘量保持在20個字以內；20～29個字的句子，可以接受；39～39個字的句子，語義必須明確，才能接受；多於40個字的句子，在任何情況下都不能接受。
錯誤：本產品適用於從由一臺伺服器進行動作控制的單一節點結構到由多臺伺服器進行動作控制的並行處理程式結構等多種體系結構。 正確：本產品適用於多種體系結構。無論是由一臺伺服器（單一節點結構），還是由多臺伺服器（並行處理結構）進行動作控制，均可以使用本產品。
同樣一個意思，儘量使用肯定句表達，不使用否定句表達。
錯誤：請確認沒有接通裝置的電源。 正確：請確認裝置的電源已關閉。
避免使用雙重否定句。
錯誤：沒有刪除許可權的使用者，不能刪除此檔案。 正確：使用者必須擁有刪除許可權，才能刪除此檔案。
（正文完）
====================================
下面是推廣時間。不過我想先說一些題外話。
如果你經常來這裡，可能會注意到，有的文章結尾有市場推廣資訊。上一篇文章就是這樣，我的《財新週刊》專欄寫到了 Udacity，他們正好在推廣奈米學位，就在那篇文章後面做了一個廣告。有的朋友因此指責我寫"軟文"，這不是事實。
事實是，我的部落格上沒有一篇是"軟文"，儘管一直有人來問價格。所有的文章都是真實想法，都是我真心想分享的東西。每一個來訪問的讀者，我都當作是朋友，不會把一篇廣告偽裝成正常的文章，去欺騙朋友。這一直是我做人的信條，不會為了一點點錢，就把這麼多年的堅持都拋棄了。
推廣活動都放在文章的結尾，明確註明是推廣，並且我只接受那些我認可的產品。對我來說，這點收入可以補貼伺服器支出；對許多讀者來說，有些資訊可能非常有用，比如下面這條。
====================================
今天推廣的主角是"海棠學院"，一個前端開發的線上教育平臺。
創始人小河就是培訓班出身，透過自身努力進入百度，深知自學者的苦惱：企業不願意要培訓班出來的學生，而學生不知道應該選哪一家培訓機構。他創業的時候，立志要做一家靠譜的、有信譽、有口碑的線上教育公司。
"海棠學院"的很多講師都有百度背景，開發過使用者上億的產品。為了做出最容易學會的課程，他們反覆嘗試，不惜放棄已經錄好的500多個課時，推倒重來。功夫不負有心人，"海棠學院"現在已經取得了很好的成績。
更難得的是，"海棠學院"是工程師的創業專案，甚至都沒有市場銷售人員，完全靠使用者的口碑來推廣。如果課程質量不好，他們馬上就完蛋了。
現在，為了發展更多的使用者，也是因為對課程很有信心，他們搞了一個活動，拋棄 "先付費、再學習" 的模式，讓使用者零成本體驗他們提供高質量培訓。
- 只需要繳納 99 元，即可感受海棠學院一週的課程，與正式學員享受一模一樣的待遇（錄播+直播+教學監管+技術輔導）。
- 一週後，如果覺得不滿意，99 元可以退款。
- 如果想繼續學下去，已經繳納的 99 元可以抵扣學費，並且學費還可以再優惠 900 元。也就是說，參加這個活動比起直接報名，可以一共節省 999 元的學費。
- 我的讀者還可以使用獨家優惠碼"ruanyifeng"，學費再抵扣 300 元。
整個課程一共需要 4.5 個月左右，涉及前端開發的各個方面，目標是透過一次系統的培訓，你就能從事前端開發這項工作。遇到不懂的地方，可以重學，他們保證讓你學會。
想從事前端開發，卻不知道從何學起的朋友，不要錯過這個機會。只需99元，就可以感受一下專業級、全方位的培訓服務，如果不滿意，99元還可以退款。
這個活動10月31日截止，因為當天就開課了，後面就恢復原價了。現在 就點選這裡瞭解詳情吧。
（完）