溫馨提示×

您好,登錄后才能下訂單哦!

密碼登錄×
登錄注冊(cè)×
其他方式登錄
點(diǎn)擊 登錄注冊(cè) 即表示同意《億速云用戶服務(wù)條款》

IT技術(shù)寫作技巧分享:慎用術(shù)語和概念

發(fā)布時(shí)間:2020-07-08 21:17:14 來源:網(wǎng)絡(luò) 閱讀:438 作者:孫衛(wèi)琴 欄目:編程語言

在技術(shù)本身不斷升級(jí)擴(kuò)展的過程中,會(huì)引進(jìn)各種各樣的新思想,例如在Java領(lǐng)域里,面向?qū)ο?、面向切面、微服?wù)、依賴注入等都是在技術(shù)發(fā)展的不同階段,出現(xiàn)的新概念。

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

例如假定在介紹Java流程控制的一章的范例中涉及到異常,此時(shí)對(duì)異常稍加解釋,然后給出參考信息:關(guān)于異常的詳細(xì)概念請(qǐng)參考本書第X章。

(3)在解釋一個(gè)概念的時(shí)候,切忌用一個(gè)深?yuàn)W的概念去解釋另一個(gè)概念。這樣會(huì)讓讀者看了之后不知所云,無法繼續(xù)深入學(xué)習(xí)。

下面分析網(wǎng)上的一段介紹“Spring Cloud”的文字:


Spring Cloud 是什么?

Spring Cloud 是一系列框架的有序集合,它利用 Spring Boot 的開發(fā)便利性簡(jiǎn)化了分布式系統(tǒng)的開發(fā),比如服務(wù)發(fā)現(xiàn)、服務(wù)網(wǎng)關(guān)、服務(wù)路由、鏈路追蹤等。Spring Cloud 并不重復(fù)造輪子,而是將市面上開發(fā)得比較好的模塊集成進(jìn)去,進(jìn)行封裝,從而減少了各模塊的開發(fā)成本。換句話說:Spring Cloud 提供了構(gòu)建分布式系統(tǒng)所需的“全家桶”。

以上這段文字中涉及到“一系列框架”、“Spring Boot”、“分布式系統(tǒng)”、“服務(wù)”、“服務(wù)發(fā)現(xiàn)”、“服務(wù)網(wǎng)關(guān)”、“服務(wù)路由”、“鏈路追蹤”、“造輪子”、“全家桶”等詞匯或術(shù)語。

對(duì)于已經(jīng)在分布式領(lǐng)域有開發(fā)基礎(chǔ)的讀者來說,他們對(duì)這段文字會(huì)比較容易理解。如果這段文字是面向開發(fā)分布式系統(tǒng)的新手,他可能對(duì)許多概念都一無所知。這時(shí)候,即使讀了這段文字,對(duì)Spring Cloud的認(rèn)識(shí)還是模模糊糊。如果要讓小白們理解Spring Cloud。就需要先介紹一些背景知識(shí),掃清讀者對(duì)基本知識(shí)的障礙,然后再引出Spring Cloud的解釋。

文中的“造輪子”、“全家桶”是一些流行語,它們往往在某個(gè)時(shí)期很流行,過一陣又銷聲匿跡。對(duì)于業(yè)界人士會(huì)熟悉這些流行語,而入門人士未必聽說過這些流行語,需要費(fèi)力地去猜測(cè)它的意思。把文中的“重復(fù)造輪子”改為“重復(fù)編寫額外的框架”,“全家桶”改為“集成框架體系”,這樣會(huì)更一目了然。

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

孫衛(wèi)琴
經(jīng)典暢銷書籍《Java面向?qū)ο缶幊獭?、《Tomcat與Java Web開發(fā)技術(shù)詳解》等的作者

向AI問一下細(xì)節(jié)

免責(zé)聲明:本站發(fā)布的內(nèi)容(圖片、視頻和文字)以原創(chuàng)、轉(zhuǎn)載和分享為主,文章觀點(diǎn)不代表本網(wǎng)站立場(chǎng),如果涉及侵權(quán)請(qǐng)聯(lián)系站長(zhǎng)郵箱:is@yisu.com進(jìn)行舉報(bào),并提供相關(guān)證據(jù),一經(jīng)查實(shí),將立刻刪除涉嫌侵權(quán)內(nèi)容。

AI