北京
我有時會想，要不要寫一寫關于技術寫作（以及如何不寫）的東西。恰好最近有人發郵件向我請教，所以這篇文章既是我過往思考的集合，也是那封回復的提煉。
任何寫作，和許多人類活動一樣，都是天賦和技能的結合。天賦，你要么有，要么就沒有；而技能可以學習、提升乃至精通。天賦很難解釋，因為它大多是無意識的。我無法告訴你，我腦海中那些模糊的念頭是怎么變成屏幕上的文字的——它就是發生了。不過，我能告訴你一些該做的和不該做的事。
技術材料有很多種。我主要寫文章、期刊論文、Unix風格的手冊頁、API文檔，還有幾本書。所以我的建議只適合這些類型。我原本覺得下面的建議都是明擺著的，不該多此一舉；但看到那么多糟糕的技術寫作后，我覺得還是有必要講。
這些建議可以濃縮成幾個要點。你的寫作應該是：
- 不同的
- 格式良好的
- 正確的
- 精確的
- 完整的
- 一致的
注意，這些建議是從做自己的技術寫作的角度出發的，也就是寫你想寫的東西。如果你的職業就是技術寫作，那么日常工作是按別人的要求來寫，而且很可能受到內部風格指南的約束。那我的建議就不適合你了。
不同
在真正動筆之前，先想想你要寫的東西到底值不值得寫。這世界真的還需要再一篇介紹C語言基本數據類型（像int和char）的文章嗎？
不過，如果你準備講得特別深、展示一些冷門的用法，或者某種創造性的應用——總之，寫出一些不一樣的東西——那就放心寫吧。
格式
對我來說，寫的東西應該排版得當，這本來再明顯不過——可我卻看過太多反面例子。格式糟糕的時候，讀起來會刺眼，整個閱讀都變成一種折磨。我甚至不理解怎么會有人把排版一團糟的東西發出來。難道他們自己看不出這東西“好難看”嗎？（我懷疑是有沒有審美基因這回事，有些人可能沒有。）
反過來，如果格式很好，排版本身會退到幕后，你幾乎注意不到它，讀起來就很輕松。
對于涉及代碼的技術寫作，代碼得用另一種字體，一般是等寬字體，通常用Courier。
這里要用“字體排印設計”（typeface）這個說法才準確。typeface是字母和符號的樣式設計，而font是特定大小（比如10磅）和風格（比如粗體）的typeface。Courier、Helvetica和Times Roman是typeface；Helvetica 10磅粗體是font。在技術寫作中，分清這兩個概念，有助于和設計師溝通，也更顯專業。
排版不只是選字體。段落的空白、標題的層級、列表的使用、代碼塊的縮進，都屬于格式。好的格式讓文檔一目了然；壞的格式則會把思維打散。如果你原本的觀點就不清晰，那么混亂的排版會讓它徹底不可讀。其實，很多寫作者不是內容不行，只是被形式拖垮了。
如果覺得自己的審美不夠用，最簡單的做法是參考成熟的排版慣例：保持一致的段落間距，統一標題樣式，用字號對比來區分層級，代碼嚴格使用等寬字體。做到這些，即使內容平實，讀者也會覺得你專業。
總之，好的技術寫作會讓人把注意力放在你要傳遞的信息上，而不是文檔本身的裝修上。如果你需要不停地為格式分心，那就說明格式還沒做好。
特別聲明：以上內容(如有圖片或視頻亦包括在內)為自媒體平臺“網易號”用戶上傳并發布，本平臺僅提供信息存儲服務。
Notice: The content above (including the pictures and videos if any) is uploaded and posted by a user of NetEase Hao, which is a social media platform and only provides information storage services.
