IT技術寫作技巧分享:慎用術語和概念

在技術本身不斷升級擴展的過程中,會引進各種各樣的新思想,例如在Java領域裏,面向對象、面向切面、微服務、依賴注入等都是在技術發展的不同階段,出現的新概念。

一本通俗易懂的書應該按照由淺入深的順序來展開知識體系。作者要對文中的概念、術語保持高度的敏感。在每句話中提及一個概念時,都要考慮以下問題:
(1)對於本書的讀者羣,這是衆所周知的簡單概念嗎?如果是,就無需解釋。例如對於Java編程的書,讀者肯定對“操作系統”具備了一些常識,就沒有必要對此解釋。
(2)對於複雜的概念,這是在書中第一次出現嗎?如果是第一次出現,就要加以解釋。如果在本節不適合重點闡述此概念,那應該提供相關的參照信息。在此處對此概念稍加解釋,再讓讀者到XXX章XXX節對此概念獲得更詳細的瞭解。

例如假定在介紹Java流程控制的一章的範例中涉及到異常,此時對異常稍加解釋,然後給出參考信息:關於異常的詳細概念請參考本書第X章。

(3)在解釋一個概念的時候,切忌用一個深奧的概念去解釋另一個概念。這樣會讓讀者看了之後不知所云,無法繼續深入學習。

下面分析網上的一段介紹“Spring Cloud”的文字:


Spring Cloud 是什麼?

Spring Cloud 是一系列框架的有序集合,它利用 Spring Boot 的開發便利性簡化了分佈式系統的開發,比如服務發現、服務網關、服務路由、鏈路追蹤等。Spring Cloud 並不重複造輪子,而是將市面上開發得比較好的模塊集成進去,進行封裝,從而減少了各模塊的開發成本。換句話說:Spring Cloud 提供了構建分佈式系統所需的“全家桶”。

以上這段文字中涉及到“一系列框架”、“Spring Boot”、“分佈式系統”、“服務”、“服務發現”、“服務網關”、“服務路由”、“鏈路追蹤”、“造輪子”、“全家桶”等詞彙或術語。

對於已經在分佈式領域有開發基礎的讀者來說,他們對這段文字會比較容易理解。如果這段文字是面向開發分佈式系統的新手,他可能對許多概念都一無所知。這時候,即使讀了這段文字,對Spring Cloud的認識還是模模糊糊。如果要讓小白們理解Spring Cloud。就需要先介紹一些背景知識,掃清讀者對基本知識的障礙,然後再引出Spring Cloud的解釋。

文中的“造輪子”、“全家桶”是一些流行語,它們往往在某個時期很流行,過一陣又銷聲匿跡。對於業界人士會熟悉這些流行語,而入門人士未必聽說過這些流行語,需要費力地去猜測它的意思。把文中的“重複造輪子”改爲“重複編寫額外的框架”,“全家桶”改爲“集成框架體系”,這樣會更一目瞭然。

總的說來,當作者在寫書時,首先要定位好讀者羣。接着寫書的時候,要一直設想自己是面對面地和讀者交流,站在讀者的角度去思考,這段話對方看得懂嗎?如果看不懂,就要採用以下方式讓讀者看懂:
(1)換一種措辭更簡單的說法。
(2)對其中的術語、概念進行解釋,並切忌用更晦澀的概念去解釋當前概念。
(3)結合典型的範例和形象的圖片來闡述當前的語句。

孫衛琴
經典暢銷書籍《Java面向對象編程》、《Tomcat與Java Web開發技術詳解》等的作者

發表評論
所有評論
還沒有人評論,想成為第一個評論的人麼? 請在上方評論欄輸入並且點擊發布.
相關文章