写作的注意事项
-
科技书稿中避免出现政治、宗教、民族等内容。
-
禁止出现黄色、暴利、赌博、软件破解和网络攻击等内容,以及其他低俗内容。
-
禁止出现机密信息(比如与军方相关的信息)。
-
内容积极向上,不可消极。
-
书稿中不准出现诋毁其他作者、书籍、软件、方法等内容。
-
书稿的文字表达要符合现代汉语习惯,准确、通顺、条理清楚;注意书面用语与口语化用语的区别,写作避免过于口语化;注意一句话的表意要"说全",不要按照口语的形式对某些内容或者语句成分进行省略。
示例(标点符号应用混乱,不该用的地方用了标点符号。该用句号的地方用了逗号;的 地 得的使用比较混乱):
最小化原则,不但验证可行性,我觉得在组织层面上,可以更加让你清晰的知道你这个阶段需要什么人,可行性一方面是验证产品需求和接受度,一方面是寻找可复制的增长方法,这样保证资金投入是最有效率的投入。另外一方面是组织方面,使你可以清晰的知道你这个阶段需要什么能力指数的人,画像更加清晰和精准。
修改后:
最小化原则不但可以验证可行性,而且在组织层面上可以让你更加清晰地知道这个阶段需要什么人,让画像更加清晰和精准。可行性的验证一方面是验证产品需求和接受度,另一方面是寻求可复制的增长方法,以保证资金的投入是有效率的。·
的 用在名词前面,地 用在动词前面 得 用在动词或者形容词后面,表示程度或结果的补语。
美丽的花朵 深深地知道 吃得很饱 掌握得不错
- 注意语句的断句,避免在长句中出现主语被偷换的问题;逗号和句号的良好使用,可将容易让读者感到困惑的部分,变得更加清楚。
示例(主语被偷换):
目前,OSSIM在中国移动、中国电信、中国石油、华为等大型企业内得到应用推广,在安全运营中心(SOC)基础上组建了OSSIM运维和二次开发团队。
对于产品经理来说,如果不知道谁是潜在的客户群体,看重什么,将无法成功开发产品。
而且当语句较长时,要拆分为简单语句。
我们描述清楚一个事物所需太多的定语,并且怎么改都感觉不清爽时,就意味着需要发明新的概念了(引入一个中间层),从而减少信息的耦合。事物十分复杂时,分层描述也是一种不错的选择。
总之,在较短的时间内暴露给读者的接口越简洁,用户越容易接受。
-
书稿中的步骤要完整、清晰,不可只以图替代步骤。
-
名词术语的使用应该准确、规范并全书统一,尤其是目录中出现的名词术语应该与正文中相应处的内容完全一致;不同的章节在名词术语的使用上也要前后一致并有所呼应。在使用名词术语的翻译时,一般在正文中首次出现时,在翻译的中文括号内写出英文(且英文为单数),建议格式为"中文(英文,缩写)",格式在全稿中建议统一。
本章后面介绍的消息队列遥测传输(Message Queuing Telemetry Transport,MQTT)协议和受限应用协议(Constrained Application Protocol,CoAP)是物联网应用层协议的两个著名示例。
-
章节标题的编排结构,建议不超过四级标题;章编号使用阿拉伯数字,比如第1章、第2章、第3章等;二期标题按照1.1、1.2、1.3编号;三级标题按照1.1.1、1.1.2、1.1.3等编号;四级标题按照1.、2.、3、等编号(如果还有五级标题,建议对标题文字进行加粗处理或者更改字体)。
-
标题是对本章、本节或本部分内容的概括,要简明扼要,要表达完整和清晰,最好具有一定的可读性(前一段时间在朋友圈中流传甚广的"公众号内卷",就是一个很好的案例)。
-
标点符号的使用应符合我国《标点符号用法》的规定,注意文中标点是否有缺失,冒号避免嵌套使用。同时注意标点符号的全半角,中文语境下用全角((如,。;:""《》------),而不要使用英文语境下的半角符号(如,.:;-等);但是代码和公式中的括号、逗号等统一使用半角。
冒号套用示例:
对任何油气公司来说,"数字化转型"都不是一段轻松的旅程,一些障碍应该预见到,比如新旧技术整合的复杂性。例如,大多数新技术都利用了IP,但是许多"遗留技术"不能这样做。其他挑战包括以下方面:
-
需要自动提取洞察力,并快速确定和执行结果操作;
-
管道、炼油厂、油井等设备产生的数据量越来越大;
-
扩大安全漏洞;
-
孤立的网络和部门。
-
在文中插入代码时请注意代码的格式,包括缩进、对齐、空格等细节,以免产生代码运行问题;程序字体一般采用CourierNew字体。
-
代码中的注释建议与前方代码的末尾保持一定且大小始终如一的距离(比如1个Tab键或者2个Tab键),一是美观,二是便于阅读。
-
注释尽量简短,注释末尾不加标点(或者统一都加)。
-
稿件中图与表格的使用,图的位置应该出现在首次引用的文字段落后(即,先文后图,图紧跟文),后文在引用图时使用"见图X-Y",避免使用"如上图、如下图"等字样,方便读者检索。其中,里面的X和Y反映的是图的编号,X表示第X章,Y表示第X章中的第Y个图,比如"图3-5"表示"第3章中的第5个图"。也就是说,图的编号是按章依次进行标记的。表的编号与图一致,但是需要注意的是,图与表的编号是分别进行的。另外,图(表)号与图(表)题之间保留一个空格。以及,图的编号和图题放在图的下面;而表号与表题放在表的上面。
- 图中涉及的文字,一般来说也会在正文中存在,要确保两者的一致性(即图文一致);表同理。
-
通常来说,图是对正文内容的形象化展示,是为了更好地理解正文内容而出现的(一图胜千言);而表起到的作用有两个:对正文内容的汇总和罗列,以一种更为清爽的格式展示正文内容;或者是对正文中现有内容进行简单的延伸(这个就不多说了)。
-
确保使用的每一个图片都有授权,或者是自己创作的;当涉及肖像权等隐私时,要么换图,要么获得当事人的书面授权。
-
图与表中不要出现涉及个人隐私的事情,以及在比如电话号码、家庭住址、身份证号码等信息时,不要使用真实信息。以及,最好不要使用这些信息举例。
-
不要使用地图(无论是咱们国家的,还是外国的)!!!!
-
不要在书稿的中文和英文之间手动加入空格,以免引入新的错误。但是英文单词和英文单词之间是需要添加空格的。
-
避免书稿内容中出现这样的情况:即在章节标题(无论是哪一级别的标题)下,直接给出"图、表或者以项目符号给出的任何文字",导致缺少文字过渡;为此,需要给出一些文字引出相关内容,让书稿看起来更像是书稿,而不是PPT或讲义。
24. 书稿中尽量不要提供网址链接(无论是国外的还是国内的),因为网址链接非常容易失效,导致无法访问。如果只是无法访问,问题还不大,要是链接到其他不可控的地方,就相当危险了。
-
软件英文名称一般使用全称,且一定要注意大小写与官方网站保持一致。比如Python,而不是python,JavaScript,而不是javascript,PowerShell,而不是powershell,也不是Powershell(在具体执行的代码中除外)
-
软件名和软件版本之间,一般的做法是空一格(凡事有特例,建议与官网保持一致。比如HTML5,而不是HTML 5)。
-
在稿件中,当中文和相应的英文并存时,建议锁定一个,尽量避免来回混用,从而做到在稿件的局部是统一的。
-
当稿件中出现外国公司、外国人名时,如果已经有了明确的中文称呼,则建议用中文(比如,通用,而不是GE;微软,而不是Microsoft;爱因斯坦,而不是Einstein)。如果是一些比较小众或者传播度不那么广泛的公司或者国外人名,则建议保留英文(比如Nautanix、Netflix等)。另外,要注意外国人名中缩写点(.)和中间点(·)的区分。
-
当书稿中存在外文图书、杂志,或者论文、规范等时,建议保留英文,以方便读者自行检索。
-
参考文献的格式规范。
样章与目录
-
在提交选题时,作者应提供图书的目录、样章(建议避开第一章)和选题申报表(编辑提供)。
-
写作过程中,定期将完成稿件交于编辑,以方便针对稿件出现的细节问题进行沟通,避免在后续 稿件中出现。
交稿说明
-
作者最后提交的稿件应使用编辑提供的交稿模板;若有特定排版要求,请另行注明。
-
交稿时应包括成书的全部内容,须包括下表中标注"√"的部分。
3. 文责作者自负,审校者对书稿负连带责任,署名审校者应承担实际的审校工作。
附:交稿模板(参考)
(注:编辑会提供一个Word的标准模板,其中基本已包含所有可用的格式,方便作者写作。)
章节体例示例:
第1章 XXXXX(不能"有1无2")
正文段落。
1.1 XXXXX
正文段落。
XXXXX
正文段落。
1.XXX(一般称为4级标题)
正文段落。
2.XXX
正文段落。
(1)XXX (此为小标题,不能有句号)
1)xxxxxxxx。(不能只有"1)"而无"2)")
-
aaaaaaaaaa。(两条及以上并列条目才能使用项目符号)
-
bbbbbbbbbb。
2)yyyyyyyyy。
(2)YYY
......
代码部分示例:
正文段落,如代码清单1-1所示。
代码清单1-1 XXXXXXXX
-
devstack@devstack:~/devstack$ neutron
-
//使用不带参数的命令neutron会进入控制台
-
(neutron) help
-
Shell commands (type help <topic>):
-
===================================
-
... //所有子命令会列举在这里
-
(neutron)
正文段落,如代码清单1-2所示。
代码清单1-2 XXXXXXXX
devstack@devstack:~/devstack$ neutron
//使用不带参数的命令neutron会进入控制台
(neutron) help
Shell commands (type help <topic>):
===================================
... //所有子命令会列举在这里
(neutron)
分项说明示例:
本段中涉及的主要术语如下。
FizzBuzz :一个在面试中测试候选人的程序。
操作系统 :一款介于计算机的物理硬件和用户之间的中间程序。
图形用户界面(GUI):用户看屏幕时看到的操作系统的一部分。
Windows :微软的操作系统。
UNIX:一款诞生于 20世纪70 年代的操作系统,苹果公司的操作系统是基于 UNIX的。
Linux:在全球范围内大多数服务器使用的开源操作系统。
开源软件:不被公司或个人拥有的软件,而是由一群志愿者进行维护。
服务器:执行特定任务(如托管一个网站)的计算机或计算机程序。
类 UNIX 操作系统 :UNIX 和 Linux。
表格式示例:
项目类型如表1-1所示。
表1-1 项目类型
项目类型 描述
核心(Core) OpenStack官方项目(绝大多会人会用到的) 孵化(Incubated) 正在开发的核心项目(即将成为核心项目) 库(Library) 核心项目的依赖库 代码准入(Gating) 集成测试套件和部署工具
图格式示例:
Dashboard登录过程如图1-1所示。
图1-1 Dashboard登录过程
注意部分示例:
注意
当组件在虚拟机创建过程中交互时,各个组件会引用通用的对象,就像这个虚拟机对象。举个例子,计算服务组件会向存储服务组件发送一个分配存储的请求。存储服务组件随后会提供请求的存储,并提供一个存储对象的引用,然后将在虚拟机对象记录中被引用。
提示部分示例:
提示
当组件在虚拟机创建过程中交互时,各个组件会引用通用的对象,就像这个虚拟机对象。举个例子,计算服务组件会向存储服务组件发送一个分配存储的请求。存储服务组件随后会提供请求的存储,并提供一个存储对象的引用,然后将在虚拟机对象记录中被引用。