技術書寫作你要知道的幾件事

2021-08-05 23:11:05 字數 1689 閱讀 6313

寫作是非常系統性的工程,需要作者和策劃一起設計寫作的路徑,根據讀者的閱讀情景、需求考慮內容的呈現形式。如果可以切實從讀者出發,首先滿足知識性需求,其次滿足閱讀的舒適度,那麼這本書應該不差。我根據評審的書稿,簡單總結技術類圖書常見的一些問題,希望大家在寫作的時候注意避免。

章節開篇(一級和二級標題下)沒有綜述性內容,尤其純技術書作者往往直接開始寫內容,這樣的作者往往缺乏整體性、全域性高度的視角,需要在寫作時經常審視自己的書稿是否有這樣的不足。

綜述性內容的必要性:這些內容可以讓讀者知道你要講什麼內容、這個內容的大體輪廓和必要的上下文。一是可以讓他提前做好閱讀閱讀準備和已有知識上下文,帶著問題和好奇心去閱讀;二是可以讓他對整體有初步的認知,也是粘合各個知識點的「粘合劑」,不要小看這部分;三是大標題下沒有文字介紹,非常突兀,其實深層次原因就是整體性的思考有欠缺。

這部分通常可以涵蓋技術功能、背景、學習價值等。

怎麼寫這部分:

綜述性內容可以涵蓋以下幾項(包括不限於):

注意:以上內容可以包含一項或者幾項。

一般來說,在寫作的時候要避免在章節開頭上來是圖或者**,因為這樣一是突兀,二是讀者沒有get到你的意圖就看圖和**,是不能有效獲取其中的資訊的,也不能構建自己的學習上下文,不能帶著目的去學習。

圖、表、**清單都要在正文說下是什麼,之後再給出,也是讓讀者有了解的心理準備。給出圖、表、**清單之後,再結合這些要素做必要的分析和總結。借用作者同學的話,是總-分-總結構。

好的書不但要告訴怎麼操作,還要告訴為什麼這麼操作;如果情況有幾種,最好要分情景來講。只寫操作,就是給他魚,告訴他為什麼才是「授人以漁」,這也算是「畫餅」,學習的動力。

技術人員往往看重操作和實現,但是讀者更願意看到你的思路和分析,**很多,github上一堆,而出書不同,我們是老師,我們要講思路、講為什麼,這個是比較重要的增值項之一。

任何時候都要記住「篇幅即資源」。所講的內容一定要緊扣主題。有的作者部分內容可能講得比較隨性,這樣即浪費篇幅,稀釋有效觀點,也讓讀者產生不好的閱讀體驗,可能放棄本書。

一般什麼樣的內容是浪費篇幅的呢:

羅里吧嗦講了一堆,其實大概就是寫作時要注意整體性描述、思路分析、讀者閱讀感受。

最後回答乙個問題,為毛我們寫作模板要用word:

* word的批註功能很nice,我們編輯可以在上面加批註,一般是寫作問題、改進建議

* word的修訂功能不要太好啊,你可以看到編輯修改了啥,當然版式的調整編輯一般不會開,你看不到她幫你做了多少工作,開了滿篇花,好咩?

* word的內容編輯比較容易統一調整,也方便生成目錄。

其他問題也還有很多,具體情況具體分析了~~

* 同乙個拼寫大小寫不統

一、不規範

* 錯別字多,雖然文字編輯會全書審校,但是問題太多了,總會有漏下的

* 避免寫成產品說明書,不要介紹很多元件、引數,但是不介紹關聯、流程和機制。

* 如果涉及自家產品,切忌寫成軟文,比較好的做法是價值驅動、痛點驅動,可以寫解決了什麼技術難題,解決思路與實現分析。

* 引用,引用是為了說明自己的觀點,不是別人的內容要作為內容的必要組成部分。

引用可以體現在腳注,並取得原作者授權。如果吸納了觀點等,可以放在參考資料或者參考文獻。

寫作絕非易事,為了讀者的利益,為了自己的品牌,筒子們,加油啦~~

關於MongoDB你需要知道的幾件事

henrique lobo weissmann是一位來自於巴西的軟體開發者,他是itexto公司的聯合創始人,這是一家諮詢公司。近日,henrique在部落格上撰文談到了關於mongodb的一些內容,其中有些觀點值得我們,特別是正在和打算使用mongodb的開發者關注。到目前為止,mongodb在巴...

關於MongoDB你需要知道的幾件事

henrique lobo weissmann是一位來自於巴西的軟體開發者,他是itexto公司的聯合創始人,這是一家諮詢公司。近日,henrique在部落格上撰文談到了關於mongodb的一些內容,其中有些觀點值得我們,特別是正在和打算使用mongodb的開發者關注。到目前為止,mongodb在巴...

關於MongoDB你需要知道的幾件事

henrique lobo weissmann是一位來自於巴西的軟體開發者,他是itexto公司的聯合創始人,這是一家諮詢公司。近日,henrique在部落格上撰文談到了關於mongodb的一些內容,其中有些觀點值得我們,特別是正在和打算使用mongodb的開發者關注。到目前為止,mongodb在巴...