我有時(shí)會(huì)想，要不要寫一寫關(guān)于技術(shù)寫作（以及如何不寫）的東西。恰好最近有人發(fā)郵件向我請(qǐng)教，所以這篇文章既是我過(guò)往思考的集合，也是那封回復(fù)的提煉。

任何寫作，和許多人類活動(dòng)一樣，都是天賦和技能的結(jié)合。天賦，你要么有，要么就沒(méi)有；而技能可以學(xué)習(xí)、提升乃至精通。天賦很難解釋，因?yàn)樗蠖嗍菬o(wú)意識(shí)的。我無(wú)法告訴你，我腦海中那些模糊的念頭是怎么變成屏幕上的文字的——它就是發(fā)生了。不過(guò)，我能告訴你一些該做的和不該做的事。

技術(shù)材料有很多種。我主要寫文章、期刊論文、Unix風(fēng)格的手冊(cè)頁(yè)、API文檔，還有幾本書。所以我的建議只適合這些類型。我原本覺(jué)得下面的建議都是明擺著的，不該多此一舉；但看到那么多糟糕的技術(shù)寫作后，我覺(jué)得還是有必要講。

這些建議可以濃縮成幾個(gè)要點(diǎn)。你的寫作應(yīng)該是：

• 不同的
• 格式良好的
• 正確的
• 精確的
• 完整的
• 一致的

注意，這些建議是從做自己的技術(shù)寫作的角度出發(fā)的，也就是寫你想寫的東西。如果你的職業(yè)就是技術(shù)寫作，那么日常工作是按別人的要求來(lái)寫，而且很可能受到內(nèi)部風(fēng)格指南的約束。那我的建議就不適合你了。

不同

在真正動(dòng)筆之前，先想想你要寫的東西到底值不值得寫。這世界真的還需要再一篇介紹C語(yǔ)言基本數(shù)據(jù)類型（像int和char）的文章嗎？

不過(guò)，如果你準(zhǔn)備講得特別深、展示一些冷門的用法，或者某種創(chuàng)造性的應(yīng)用——總之，寫出一些不一樣的東西——那就放心寫吧。

格式

對(duì)我來(lái)說(shuō)，寫的東西應(yīng)該排版得當(dāng)，這本來(lái)再明顯不過(guò)——可我卻看過(guò)太多反面例子。格式糟糕的時(shí)候，讀起來(lái)會(huì)刺眼，整個(gè)閱讀都變成一種折磨。我甚至不理解怎么會(huì)有人把排版一團(tuán)糟的東西發(fā)出來(lái)。難道他們自己看不出這東西“好難看”嗎？（我懷疑是有沒(méi)有審美基因這回事，有些人可能沒(méi)有。）

反過(guò)來(lái)，如果格式很好，排版本身會(huì)退到幕后，你幾乎注意不到它，讀起來(lái)就很輕松。

對(duì)于涉及代碼的技術(shù)寫作，代碼得用另一種字體，一般是等寬字體，通常用Courier。

這里要用“字體排印設(shè)計(jì)”（typeface）這個(gè)說(shuō)法才準(zhǔn)確。typeface是字母和符號(hào)的樣式設(shè)計(jì)，而font是特定大?。ū热?0磅）和風(fēng)格（比如粗體）的typeface。Courier、Helvetica和Times Roman是typeface；Helvetica 10磅粗體是font。在技術(shù)寫作中，分清這兩個(gè)概念，有助于和設(shè)計(jì)師溝通，也更顯專業(yè)。

排版不只是選字體。段落的空白、標(biāo)題的層級(jí)、列表的使用、代碼塊的縮進(jìn)，都屬于格式。好的格式讓文檔一目了然；壞的格式則會(huì)把思維打散。如果你原本的觀點(diǎn)就不清晰，那么混亂的排版會(huì)讓它徹底不可讀。其實(shí)，很多寫作者不是內(nèi)容不行，只是被形式拖垮了。

如果覺(jué)得自己的審美不夠用，最簡(jiǎn)單的做法是參考成熟的排版慣例：保持一致的段落間距，統(tǒng)一標(biāo)題樣式，用字號(hào)對(duì)比來(lái)區(qū)分層級(jí)，代碼嚴(yán)格使用等寬字體。做到這些，即使內(nèi)容平實(shí)，讀者也會(huì)覺(jué)得你專業(yè)。

總之，好的技術(shù)寫作會(huì)讓人把注意力放在你要傳遞的信息上，而不是文檔本身的裝修上。如果你需要不停地為格式分心，那就說(shuō)明格式還沒(méi)做好。