開發者倡導手冊(9):撰寫部落格和文章

作者:Christian Heilmann
編譯:莊七
網路寫作是一項專業技能。很多時候,你會發現人們在寫線上文章或部落格文章時運用其他媒體的規則。成功率很低。
請注意,網路上的文字不是孤零零的在某一個地方發佈的,而是以書籤、鏈接和參考文獻的形式在整個網路上傳播。因此,重要的是將文字分成易於消化、可引用和可重複的幾塊,並使你的文章標題和文件標題在沒有全文的情況下也能發揮作用。
事實:這也是一個無障礙的好處。像螢幕閱讀器這樣的輔助技術允許你按標題瀏覽文件,而不是把整個文件當作一大塊來聽。
簡單並不愚蠢
寫簡單的文字是艱苦的工作。寫出令人印象深刻的文章則比較容易。你經常看到人們試圖通過使用複雜的詞語和參考資料來打動觀眾。當你寫小說或歌詞時,這很好,在玩弄語言時有很多樂趣。然而,在網路上,尤其是在開發人員佈道方面,你的目標應該是盡可能地讓人理解。請考慮以下簡單文字的特徵:
-
用簡單的術語寫作需要大量的工作和對主題的徹底理解。你需要熟悉這個主題,才能用簡單的語言解釋它。如果你不能用簡單的語言解釋,很可能你自己還沒有完全掌握這個主題。
-
如果用盡可能簡單的術語解釋事情,就能確自己保接觸到最可能多的讀者。
-
簡單的措辭讓非母語人士有機會了解整個事情的內容,也許還可以花些時間使用翻譯工具,使之對他們有用。
-
簡短、容易掌握的句子讀起來不那麼累人。當你看第一眼時,它們也不會讓人感到畏懼。在閱讀文字之前掃描文字是網路上非常常見的模式——特別是在移動裝置上。
警告:然而,在用簡單的術語解釋複雜的事情和聽起來居高臨下之間有一條界限。如果你懷疑自己在”簡單化”的道路上走得太遠,可以讓別人看一下你的文章以避免這個問題。閱讀和重讀你所寫的東西(中間休息一下),並使它在每一次反覆中變得更容易。 與現實生活中的物體和場景進行比較,可以很好地簡化複雜的問題。
例子:在雅虎工作的 “黑客開放日”,我和幾個媒體人談過,他們對黑客日和開放 API 的概念感到非常困惑。那時,這些都是全新的東西。我是這樣解釋的。「如果雅虎是一家汽車公司,我們最新的車型會在這裡被拆解,我們會允許人們玩弄這些零件。也許他們會找到一種很酷的新方法來組裝它們,這就是我們想要的使汽車更環保、更高效的突破。」 提示:我在網上寫作時經常使用的一個工具是海明威。你可以到hemingwayapp.com試用它。它是一個線上編輯器,給你一個指標,說明你的文字需要什麼閱讀年齡。它標記出常見的問題,如句子太長或過於複雜的單詞。
簡單直接——不要用糖衣包裹
你的標題和介紹性文字是一個部落格最重要的部分。兩者都決定了將來找到這個帖子的難易程度。報紙已經使我們有條件寫出詼諧有趣的標題,其中包括流行語和典故。這很有趣,但你讀了它們,說明已經買了報紙。網路標題會變成鏈接、書籤和社交媒體分享。因此,它們需要在沒有其他文字的情況下有意義。對於一篇技術性的部落格文章,要說明文章的內容——不要試圖變得太聰明。流行的參考資料甚至更糟糕,因為這些資料並不能很好地轉化為其他文化。問問自己:你是想在一分鐘內表現出創造性和詼諧,還是想在幾個月內提供有效的資訊?
部落格文章應該像廣播中的新聞專案一樣:
-
在任何部落格的開頭,都要說明發生了什麼,在哪裡發生,如何發生。
-
繼續解釋部落格中的內容。
-
然後進入細節。
這將防止任何混淆,並讓感興趣的人去了解更多。當在社交媒體和任何地方分享時,人們以自動方式鏈接到你的文件,他們將可能使用部落格的標題——無論是 HTML 中的標題還是文件的大標題。如果你的標題脫離上下文,顯得沒有意義,就不會有很多人點擊它們。
提示:大多數社交網絡都有鏈接預覽,可以自動將鏈接擴展到其標題和第一張圖片。這一點很重要,也是一個可以利用的強大的東西。熟悉你的文章中需要的元標籤,以便在你選擇的社交媒體平臺上獲得一個合理的和令人興奮的預覽。
內容長度
線上使用的技術寫作是指保持簡短和直接的內容。人們很忙,想要了解事實。
提示:為了寫出好的文章,要寫,要讀,要刪除不需要的東西,要再讀,要刪除更多的東西,如此反覆。如果你不能再刪除了,你就達到了發表的目的。 如果你有很多內容要講,為什麼不把它分成幾篇?這將使你能夠在第一篇文章的結尾處預告下一篇文章將在幾天后發表,並使你的部落格有重複訪問者。
添加多媒體內容
如果可以,在部落格中加入相關的媒體。一張介紹性的照片可以吸引人的眼球,並引誘大腦閱讀所發生的事情。我們很幸運,現在嵌入影片、音訊和投影片就像複製貼上一樣容易。
嵌入多媒體將我們的資訊綁在一起,易於消化。它還允許訪問者在第一時間瀏覽文章,並在稍後回來閱讀其他內容(觀看影片、下載播客)。它還可以幫助那些很難閱讀但很有能力聽或看的人。
在嵌入多媒體時,確保也要寫上說明性的文字——圖片需要有好的替代文字,影片至少要有對它們所顯示內容的描述。
提示:通過提供文字替代物或你的筆記,投影片的效果會好很多。許多投影片託管平臺會自動為你的投影片創建一個 HTML 腳本。就我個人而言,我從我的筆記開始,然後根據這些筆記創建我的投影片——這樣,我總是有一個 HTML 版本可以從投影片中鏈接到。
結構化內容
構建你的內容是非常重要的。給讀者提供地標,讓他們在決定閱讀你的資訊之前先瀏覽一下文章結構,由於人們很忙,這一點非常好。
你通過使用分層的標題結構來實現這一點。這也將有助於使用螢幕閱讀器等輔助技術的人快速地從一個部分跳到另一個部分。如果你在標題中加入 ID,人們就可以將文件的某些部分作為書籤,並將鏈接發送給朋友,使他們直接到達他們想去的地方。
提示:從你的標題大綱開始,你寫文章的速度會快很多。你甚至可以在不同時間寫文章的不同部分。通常情況下,當我被文章的某一部分卡住,面臨一些寫作障礙時,我會暫時跳過它,寫其他更容易或更熟悉的部分。 結構化的文章也意味著使用短句子。它意味著一次處理一件事的段落。它意味著使用列表來解釋一步一步的過程,或對現有的內容進行概述。對於大型文件,它還意味著提供一個目錄,使人們能夠直接跳到他們需要的地方。
給你的內容打上時間戳
如果你吃的食物超過了”最佳食用日期”,你就會生病。如果你不給你的出版物打上時間戳,它們將被認為是永遠正確——即使按照未來的技術標準它們是有害的。它們會被引用——有時是糟糕的引用,並被反覆引用,被當作真理。
例子:當我開始做網站開發的時候,用於布局的表格是建立網站的唯一方法。你必須知道很多技巧才能使這些表格在 Netscape3 和 IE4 以及其他”有趣”的瀏覽器上工作。我發表過幾篇關於如何做到這一點的文章。現在,表格布局對網頁開發來說是適得其反的,而且實際上渲染速度更慢。如果我的文章上沒有日期,也許人們還會認為它們有意義。所有的”CSS 布局太難了 「的文章肯定暗示了這一點。 我們的技術環境以極快的速度發展。半年前的 “最佳實踐 「現在很可能被認為是”有害的」。因此,讓我們確保讀者在遵循某份文件的建議之前,即使現在也要知道它是什麼時候寫的。
引證以證明
本節的另一個要點是引用其他來源並連結到你所建立的內容。通過引用其他來源(當然是在閱讀之後),驗證了你的想法和事實。讀者不必盲目地相信你——他們可以通過比較來明確自己的想法。
先發制人
請記住,作為開發者布道師,你是技術人員和外部世界以及技術人員和你自己公司之間的缺失環節。這給了你一個其他公司部門做宣傳時無法完成的任務,我稱之為先發制人的寫作。
我的意思是,當你談論產品的時候,你不應該 “推銷”它們。相反,你的工作是讓開發者對它們感興趣,讓他們成為你的銷售人員。這方面的主要任務是預測如果你做一個普通的銷售推銷會得到的反饋,並在反饋發生之前回答它——先發制人的寫作。
不要試圖用糖衣炮彈或隱藏負面信息:而是解釋為什麼會發生,發生時該怎麼做,以及如何向負責解決該問題的人報告。
事實是:作為開發者,我們是一群憤世嫉俗的人,多年來被打破的承諾使我們變得堅韌。對任何產品的過度興奮和積極的描述都不會讓我們認為”我必須得到一些這樣的產品」,而更有可能引發”好吧,有什麼好處”的疑問。 這使得開發者看起來不善於交際,對於一個市場營銷或公關人員來說,如果做了一個經典的推銷,卻面臨著一連串的負面反饋,這可能是令人難以置信的沮喪。你的工作是預測這種反饋的一部分,並通過在你的文章中承認它來解除這種情況。這對你的公關和營銷部門來說可能是一個難點,但你可以這樣向他們解釋:通過公開好的和壞的,你可以避免很多混亂的或不好的反饋,這些反饋會被媒體斷章取義,給公關部門帶來很多工作。
提示:最近,公關部門也開始採用先發制人的寫作理念。我一直看到的一個過程是為即將發布的新產品創建一個”無禮的問答」。該產品的團隊創建了一個故意粗魯和有問題的問題清單,並舉辦一個研討會,討論如何處理這些問題。如果這些問題在真正的發布時沒有出現,那麼很好。然而,如果它們真的出現了,你就有了準備。 負面的反饋在很多情況下分為幾類,所有這些通常都是以”網際網路巨頭”的方式來展示作者。
事實是:雖然有些人是巨魔,喜歡用負面的反饋來製造麻煩或”對抗系統」,或試圖哄騙人們不必要地延長討論,但其他人卻因為一次次的失望而不由自主地這樣做。這是一個很難保持的平衡。真正的巨魔應該被簡單地忽略,或者像俗話說的那樣”不要餵巨魔”。但人們可能因為發帖太快或憤怒而成為一個”意外的巨魔」。無視負面反饋可能是很誘人的,但有時措辭暗示了另一個問題,你可以而且應該解決。 這裡有幾類負面反饋和預先避免它們的技巧:
-
這對我來說根本不起作用:確保以必要的細節來定義運行你所談論的產品或演示所需的環境。
-
這與 Y 公司的產品 X 一樣:很多時候這是個競爭對手的粉絲。提到你的產品與其他產品非常相似,並列出它們。詳細解釋兩者的不同之處,並說明你的產品不僅僅是一個副本。通過展示你對其他產品的了解,你證明你確實做了功課,並且仍然認為值得談論它。不要讓人們發現你沒有做研究。
-
很好,但我永遠也用不到,沒有人需要它:詳細解釋該產品解決了什麼問題。如果這不是一個現在常見的問題,而是未來的一個問題,則要求反饋人們如何喜歡這個產品。同時告訴他們,這是一個機會,以確保一旦他們遇到這個問題,產品就會準備好,而且很好。
-
當你的產品 Y 仍然是壞的時候,你為什麼要在這上面浪費時間?: 確保你的寫作設定了文章的範圍。詳細地談論一個產品。如果你很幸運,其他人會回答這樣的評論,並指出它是不合適的。如果不是,迅速回答說它是,並指出一個不同的主題或討論,在那裡該人可以發洩他們對其他產品的不愉快。
-
我喜歡這一點,但我沒有時間來測試:準備一些帶有簡單反饋機制的演示和代碼例子,讓人們通過簡單的點擊來嘗試,甚至可能提供一個簡單的調查。
這些只是幾個例子,說明可以利用全面披露來預先避免不良反饋。還有很多,但我相信你會找到處理這個問題的好方法。好好看看你寫的材料,試著在壞的反饋發生之前預測它。你通過提供更清晰的信息所能避免的任何誤解都可能是另一個快樂的客戶。
行動呼籲及更多信息
當你完成了你的文章,用行動呼籲來結束是有意義的。你應該重複使用的資源,在哪裡可以找到更多,以及如何聯繫你或你所寫的產品的團隊。

轉載請註明:開發者關係 »