|
|
在技术本身不断升级扩展的过程中，会引进各种各样的新思想，例如在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）结合典型的范例和形象的图片来阐述当前的语句。
孙卫琴
2019/5/1
[这个贴子最后由 sunweiqin 在 2021-09-23 10:51:51 重新编辑]
|
|
Java技术网站 → 『 Java开发技术 』 → 『 孙卫琴姐姐的Java技术专栏 』 → IT技术书写作技巧分享：慎用概念和术语
消息
查看
搜索
好友
邮件
复制
引用
IP: 已设置保密
