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)结合典型的范例和形象的图片来阐述当前的语句。

孙卫琴

原文地址:https://blog.51cto.com/sunweiqin/2407567

时间: 2024-10-10 20:07:19

IT技术写作技巧分享:慎用术语和概念的相关文章

论文写作技巧分享

中学生初学议论文写作时,往往无从下手,即使勉强去写,也往往是以叙代议,或空发议论,不符合议论文的基本要求.这是中学生作文训练中从记叙文过渡到议论文时经常且普遍出现的现象.为了帮助学生解决这个问题,给他们一个入门向导,我在指导议论文训练时试用了以下四种方法,效果较好.现以命题作文为例,把四种方法的运用情况介绍如下,供广大师生参考. 一.宽大题目缩小做 所谓宽大题目,指文题从字面上看是要讲大道理的,论述范围很宽泛,初写议论文的人一时还难以驾驭它.对这样的文题,就需要"小做",即把文题适当&

新手写作博客文章内容技巧分享

现在是一个凡是讲究快的时代,一般用户在网上浏览文文章时,基本不会在网页上停留很长时间,很多都是只会浮光掠影的扫视内容,都是通过在页面上扫视来获取信息,找寻关键字.短语和视觉线索,所以新手在博客文章内容在写作时就要注意一些细节. 新手写作博客文章内容技巧分享 自媒体 思考 经验心得 第1张 总结了一下几个方面: 一.文章排版 列表-文章在排版时使用列表,可以给人简洁有序的感觉,带有符合和编号的给人的感觉更清晰 加粗-文章段落中可以使用粗体和其他格式来强调重点,不过要注意次数,不要走极端,全部加 粗

自媒体爆文的写作技巧有哪些?分享4个创作小技巧!

从事自媒体运营行业的小伙伴,最大的目标就是自己能创作出爆款.不管是做文章的自媒体还是短视频自媒体,都想自己的创作内容能够引爆全网.因为只有自己创作的内容能够持续地获得高阅读高流量自己才会又稳定的收益. 今天小编就跟大家说说如何打造自媒体爆文,自媒体爆文的创作有哪些写作技巧. 关于爆文是如何打造的相信大家在网上也看了很多相关的资料,自己心里也知道是怎么回事,但是创作过程当中的一些细节小技巧大家都真的了解吗?今天小编就为大家简单的分享一下. 1.文章传送的知识点 我们创作的内容是需要给用户一定的知识

新手应该知道的自媒体爆文写作技巧,干货分享

自媒体运营人员最重视的就是自己创作文章的阅读量,因为这直接关系到自己的收益.那么如何打造自媒体爆文或者更多的阅读量提高自己的收益呢?今天易撰自媒体小编就跟大家分享一些自媒体爆文写作技巧.首先,我们需要弄清楚什么是爆文?自媒体爆文根据不同的领域定义的标准都是不一样的.科技领域的文章阅读量能够达到10万+可以算是非常不错的爆文了.而娱乐领域类的文章阅读量达到百万或者几百万+才算是比较不错的爆文.那么如何创作出爆文呢??一.先达到官方要求的机制1.你要垂直,题目.文章.以及你选的类目三者要吻合.2.不

论文的写作要求、流程与写作技巧

论文的写作要求.流程与写作技巧 广义来说,凡属论述科学技术内容的作品,都称作科学著述,如原始论著(论文).简报.综合报告.进展报告.文献综述.述评.专著.汇编.教科书和科普读物等.但其中只有原始论著及其简报是原始的.主要的.第一性的.涉及到创造发明等知识产权的.其它的当然也很重要,但都是加工的.发展的.为特定应用目的和对象而撰写的.下面仅就论文的撰写谈一些体会.在讨论论文写作时也不准备谈有关稿件撰写的各种规定及细则.我主要谈的是论文写作中容易发生的问题和经验,是论文写作道德和书写内容的规范问题.

MarkDown写作技巧

# MarkDown写作技巧 #年轻的我们往往苦恼于没有充实的社会经历.社会阅历,很难有较强的个人能力.个人魅力!就个人能力而言,无非分为两种:“吸收能力”和“输出能力”.吸收能力主要体现了个人对外界知识的摄入能力,主要包括:学习能力.阅读能力.听取能力.分析能力.理解能力等,这些能力可以帮助自己吸取理解进而加以分析自身的外界知识.与吸收能力相比,输出能力更是体现个人社会价值的一种能力了,其主要包括:概括能力.总结能力.表达能力.沟通能力.讲演能力和写作能力等.为了更好地表达与沟通,也许我们要做

win10系统操作技巧分享

Win10系统正式版发布后,很多人都迫不及待更新了win10系统.不少的人在更新了win10系统之后才发现win10系统操作起来并不是那么得心应手,win10系统要怎么操作呢?win10系统操作的技巧是怎样的呢?那么,小编就把win10系统操作技巧分享给大家! Win10技巧1.窗口1/4分屏 从Win7时代开始,微软便引入了屏幕热区概念,即当你需要将一个窗口快速缩放至屏幕1/2尺寸时,只需将它直接拖拽到屏幕两边即可.在Win10中你会发现这项功能大大加强,除了左.右.上这三个热区外,我们还能拖

个人收集的国外Oracle优秀技术博客分享

个人收集的国外的优秀的Oracle博客网站,有需要的拿去,不能访问的请自行翻墙 1. http://www.oratechinfo.co.uk/ http://www.oratechinfo.co.uk/ 2. oracle官方文档汇总 1> 10.2官方文档 http://www.oracle.com/pls/db102/homepage 2> 11.2官方文档 http://docs.oracle.com/cd/E11882_01/index.htm 3> 12.1官方文档 http

Sybase数据库技术,数据库恢复---分享Sybase数据库知识(博客文章索引@51cto)

Sybase数据库技术,数据库恢复分享Sybase数据库知识 博客文章列表,更新时间:2014-12-14 Sybase数据库技术,数据库恢复 站点地图 最新文章 ASE使用with ignore_dup_row删除重复数据  (评论 0   阅读 50) ASE 16静默方式安装并创建服务器  (评论 0   阅读 80) ASE执行sp_remotesql报错:Msg 11224, Level 16, State 2  (评论 0   阅读 72) Sybase支持浪潮天梭K1系统  (评论