作者：Christian Heilmann
编译：庄七
網路寫作是一項專業技能。很多時候，你會發現人們在寫線上文章或部落格文章時運用其他媒體的規則。成功率很低。
請注意，網路上的文字不是孤零零的在某一個地方發佈的，而是以書籤、鏈接和參考文獻的形式在整個網路上傳播。因此，重要的是將文字分成易於消化、可引用和可重複的幾塊，並使你的文章標題和文件標題在沒有全文的情況下也能發揮作用。
事實：這也是一個無障礙的好處。像螢幕閱讀器這樣的輔助技術允許你按標題瀏覽文件，而不是把整個文件當作一大塊來聽。
簡單並不愚蠢
寫簡單的文字是艱苦的工作。寫出令人印象深刻的文章則比較容易。你經常看到人們試圖通過使用複雜的詞語和參考資料來打動觀眾。當你寫小說或歌詞時，這很好，在玩弄語言時有很多樂趣。然而，在網路上，尤其是在開發人員佈道方面，你的目標應該是盡可能地讓人理解。請考慮以下簡單文字的特徵：
-
用簡單的術語寫作需要大量的工作和對主題的徹底理解。你需要熟悉這個主題，才能用簡單的語言解釋它。如果你不能用簡單的語言解釋，很可能你自己還沒有完全掌握這個主題。
-
如果用盡可能簡單的術語解釋事情，就能確自己保接觸到最可能多的讀者。
-
簡單的措辭讓非母語人士有機會了解整個事情的內容，也許還可以花些時間使用翻譯工具，使之對他們有用。
-
簡短、容易掌握的句子讀起來不那麼累人。當你看第一眼時，它們也不會讓人感到畏懼。在閱讀文字之前掃描文字是網路上非常常見的模式——特別是在移動裝置上。
警告：然而，在用簡單的術語解釋複雜的事情和聽起來居高臨下之間有一條界限。如果你懷疑自己在”簡單化”的道路上走得太遠，可以讓別人看一下你的文章以避免這個問題。閱讀和重讀你所寫的東西（中間休息一下），並使它在每一次反覆中變得更容易。 與現實生活中的物體和場景進行比較，可以很好地簡化複雜的問題。
例子：在雅虎工作的 “黑客開放日”，我和幾個媒體人談過，他們對黑客日和開放 API 的概念感到非常困惑。那時，這些都是全新的東西。我是這樣解釋的。「如果雅虎是一家汽車公司，我們最新的車型會在這裡被拆解，我們會允許人們玩弄這些零件。也許他們會找到一種很酷的新方法來組裝它們，這就是我們想要的使汽車更環保、更高效的突破。」 提示：我在網上寫作時經常使用的一個工具是海明威。你可以到hemingwayapp.com試用它。它是一個線上編輯器，給你一個指標，說明你的文字需要什麼閱讀年齡。它標記出常見的問題，如句子太長或過於複雜的單詞。
簡單直接——不要用糖衣包裹
你的標題和介紹性文字是一個部落格最重要的部分。兩者都決定了將來找到這個帖子的難易程度。報紙已經使我們有條件寫出詼諧有趣的標題，其中包括流行語和典故。這很有趣，但你讀了它們，說明已經買了報紙。網路標題會變成鏈接、書籤和社交媒體分享。因此，它們需要在沒有其他文字的情況下有意義。對於一篇技術性的部落格文章，要說明文章的內容——不要試圖變得太聰明。流行的參考資料甚至更糟糕，因為這些資料並不能很好地轉化為其他文化。問問自己：你是想在一分鐘內表現出創造性和詼諧，還是想在幾個月內提供有效的資訊？
部落格文章應該像廣播中的新聞專案一樣：
-
在任何部落格的開頭，都要說明發生了什麼，在哪裡發生，如何發生。
-
繼續解釋部落格中的內容。
-
然後進入細節。
這將防止任何混淆，並讓感興趣的人去了解更多。當在社交媒體和任何地方分享時，人們以自動方式鏈接到你的文件，他們將可能使用部落格的標題——無論是 HTML 中的標題還是文件的大標題。如果你的標題脫離上下文，顯得沒有意義，就不會有很多人點擊它們。
提示：大多數社交網絡都有鏈接預覽，可以自動將鏈接擴展到其標題和第一張圖片。這一點很重要，也是一個可以利用的強大的東西。熟悉你的文章中需要的元標籤，以便在你選擇的社交媒體平台上獲得一個合理的和令人興奮的預覽。
內容長度
線上使用的技術寫作是指保持簡短和直接的內容。人們很忙，想要了解事實。
提示：為了寫出好的文章，要寫，要讀，要刪除不需要的東西，要再讀，要刪除更多的東西，如此反覆。如果你不能再刪除了，你就達到了發表的目的。 如果你有很多內容要講，為什麼不把它分成幾篇？這將使你能夠在第一篇文章的結尾處預告下一篇文章將在幾天后發表，並使你的部落格有重複訪問者。
添加多媒體內容
如果可以，在部落格中加入相關的媒體。一張介紹性的照片可以吸引人的眼球，並引誘大腦閱讀所發生的事情。我們很幸運，現在嵌入影片、音訊和投影片就像複製貼上一樣容易。
嵌入多媒體將我們的資訊綁在一起，易於消化。它還允許訪問者在第一時間瀏覽文章，並在稍後回來閱讀其他內容（觀看影片、下載播客）。它還可以幫助那些很難閱讀但很有能力聽或看的人。
在嵌入多媒體時，確保也要寫上說明性的文字——圖片需要有好的替代文字，影片至少要有對它們所顯示內容的描述。
提示：通過提供文字替代物或你的筆記，投影片的效果會好很多。許多投影片託管平台會自動為你的投影片創建一個 HTML 腳本。就我個人而言，我從我的筆記開始，然後根據這些筆記創建我的投影片——這樣，我總是有一個 HTML 版本可以從投影片中鏈接到。
結構化內容
構建你的內容是非常重要的。給讀者提供地標，讓他們在決定閱讀你的資訊之前先瀏覽一下文章結構，由於人們很忙，這一點非常好。
你通過使用分層的標題結構來實現這一點。這也將有助於使用螢幕閱讀器等輔助技術的人快速地從一個部分跳到另一個部分。如果你在標題中加入 ID，人們就可以將文件的某些部分作為書籤，並將鏈接發送給朋友，使他們直接到達他們想去的地方。
提示：從你的標題大綱開始，你寫文章的速度會快很多。你甚至可以在不同時間寫文章的不同部分。通常情況下，當我被文章的某一部分卡住，面臨一些寫作障礙時，我會暫時跳過它，寫其他更容易或更熟悉的部分。 結構化的文章也意味著使用短句子。它意味著一次處理一件事的段落。它意味著使用列表來解釋一步一步的過程，或對現有的內容進行概述。對於大型文件，它還意味著提供一個目錄，使人们能够直接跳到他们需要的地方。
给你的内容打上时间戳
如果你吃的食物超过了”最佳食用日期”，你就会生病。如果你不给你的出版物打上时间戳，它们将被认为是永远正确——即使按照未来的技术标准它们是有害的。它们会被引用——有时是糟糕的引用，并被反复引用，被当作真理。
例子：当我开始做网站开发的时候，用于布局的表格是建立网站的唯一方法。你必须知道很多技巧才能使这些表格在 Netscape3 和 IE4 以及其他”有趣”的浏览器上工作。我发表过几篇关于如何做到这一点的文章。现在，表格布局对网页开发来说是适得其反的，而且实际上渲染速度更慢。如果我的文章上没有日期，也许人们还会认为它们有意义。所有的”CSS 布局太难了 “的文章肯定暗示了这一点。 我们的技术环境以极快的速度发展。半年前的 “最佳实践 “现在很可能被认为是”有害的”。因此，让我们确保读者在遵循某份文件的建议之前，即使现在也要知道它是什么时候写的。
引证以证明
本节的另一个要点是引用其他来源并链接到你所建立的内容。通过引用其他来源（当然是在阅读之后），验证了你的想法和事实。读者不必盲目地相信你——他们可以通过比较来明确自己的想法。
先发制人
请记住，作为开发者布道师，你是技术人员和外部世界以及技术人员和你自己公司之间的缺失环节。这给了你一个其他公司部门做宣传时无法完成的任务，我称之为先发制人的写作。
我的意思是，当你谈论产品的时候，你不应该 “推销”它们。相反，你的工作是让开发者对它们感兴趣，让他们成为你的销售人员。这方面的主要任务是预测如果你做一个普通的销售推销会得到的反馈，并在反馈发生之前回答它——先发制人的写作。
不要试图用糖衣炮弹或隐藏负面信息：而是解释为什么会发生，发生时该怎么做，以及如何向负责解决该问题的人报告。
事实是：作为开发者，我们是一群愤世嫉俗的人，多年来被打破的承诺使我们变得坚韧。对任何产品的过度兴奋和积极的描述都不会让我们认为”我必须得到一些这样的产品”，而更有可能引发”好吧，有什么好处”的疑问。 这使得开发者看起来不善于交际，对于一个市场营销或公关人员来说，如果做了一个经典的推销，却面临着一连串的负面反馈，这可能是令人难以置信的沮丧。你的工作是预测这种反馈的一部分，并通过在你的文章中承认它来解除这种情况。这对你的公关和营销部门来说可能是一个难点，但你可以这样向他们解释：通过公开好的和坏的，你可以避免很多混乱的或不好的反馈，这些反馈会被媒体断章取义，给公关部门带来很多工作。
提示：最近，公关部门也开始采用先发制人的写作理念。我一直看到的一个过程是为即将发布的新产品创建一个”无礼的问答”。该产品的团队创建了一个故意粗鲁和有问题的问题清单，并举办一个研讨会，讨论如何处理这些问题。如果这些问题在真正的发布时没有出现，那么很好。然而，如果它们真的出现了，你就有了准备。 负面的反馈在很多情况下分为几类，所有这些通常都是以”互联网巨头”的方式来展示作者。
事实是：虽然有些人是巨魔，喜欢用负面的反馈来制造麻烦或”对抗系统”，或试图哄骗人们不必要地延长讨论，但其他人却因为一次次的失望而不由自主地这样做。这是一个很难保持的平衡。真正的巨魔应该被简单地忽略，或者像俗话说的那样”不要喂巨魔”。但人们可能因为发帖太快或愤怒而成为一个”意外的巨魔”。无视负面反馈可能是很诱人的，但有时措辞暗示了另一个问题，你可以而且应该解决。 这里有几类负面反馈和预先避免它们的技巧：
-
这对我来说根本不起作用：确保以必要的细节来定义运行你所谈论的产品或演示所需的环境。
-
这与 Y 公司的产品 X 一样：很多时候这是个竞争对手的粉丝。提到你的产品与其他产品非常相似，并列出它们。详细解释两者的不同之处，并说明你的产品不仅仅是一个副本。通过展示你对其他产品的了解，你证明你确实做了功课，并且仍然认为值得谈论它。不要让人们发现你没有做研究。
-
很好，但我永远也用不到，没有人需要它：详细解释该产品解决了什么问题。如果这不是一个现在常见的问题，而是未来的一个问题，则要求反馈人们如何喜欢这个产品。同时告诉他们，这是一个机会，以确保一旦他们遇到这个问题，产品就会准备好，而且很好。
-
当你的产品 Y 仍然是坏的时候，你为什么要在这上面浪费时间？： 确保你的写作设定了文章的范围。详细地谈论一个产品。如果你很幸运，其他人会回答这样的评论，并指出它是不合适的。如果不是，迅速回答说它是，并指出一个不同的主题或讨论，在那里该人可以发泄他们对其他产品的不愉快。
-
我喜欢这一点，但我没有时间来测试：准备一些带有简单反馈机制的演示和代码例子，让人们通过简单的点击来尝试，甚至可能提供一个简单的调查。
这些只是几个例子，说明可以利用全面披露来预先避免不良反馈。还有很多，但我相信你会找到处理这个问题的好方法。好好看看你写的材料，试着在坏的反馈发生之前预测它。你通过提供更清晰的信息所能避免的任何误解都可能是另一个快乐的客户。
行动呼吁及更多信息
当你完成了你的文章，用行动呼吁来结束是有意义的。你应该重复使用的资源，在哪里可以找到更多，以及如何联系你或你所写的产品的团队。
转載請註明：開發者關係 »
