在本章中, 书籍设计 意味着一本书的各种典型组成部分的内容、风格、格式、设计和顺序。“组件”在这里是指书本的实际章节或页面,例如版次声明、前言、索引,或前封面或后封面。在 页面设计章节, 该术语 元素 指的是可以在书中几乎任何地方多次出现的事物,例如页眉、页脚、表格、插图、列表、通知、突出显示等等。

以下内容概述了印刷技术书籍的典型组成部分以及这些组成部分的典型内容、格式、风格和顺序。 当然,没有任何单一的用户指南、技术参考手册、快速参考文档或其他类似文档会以你将要阅读的方式,精确地设计并安排所有这些组成部分。 相反,本综述将概述各种可能性—比如说可能性的范围。

注意: 目前,我们只有示例。 用户指南 在 FrameMaker 中开发,然后输出为 PDF。它缺少词汇表,但典型用户指南的所有其他部分都已到位。(我弄不懂“Filepad”里那个“d”是什么意思!)请注意,它没有使用下面列出的一些字体和页边距要求。

在开始阅读以下内容之前,先拿几本有关硬件和软件的书,这样你就可以将它们的内容、风格、格式和编排与这里讨论的内容进行比较。

若要获得比此处所示更详尽的信息,请查阅以下两份行业标准资料:

您可以在……看到这些书籍组件的示例 技术文档设计.

封面和封底

面向付费客户的产品文档通常拥有设计精美的封面,即便书的内部在质量方面属于最廉价的档次。在封面上,您通常会看到以下部分或全部内容:

要确定公司名称、产品名称和书名的良好格式可能颇具挑战。有时,这些可能会构成整整一段文字!关于是否在封面上标注版本和发布号,公司意见分歧很大—有些会标注;有些不会。不过,几乎总能看到会标明所支持的平台—例如产品是针对 Macintosh、PC、UNIX 等等。

纸质用户指南和手册的封底通常非常简单。通常,它包含书籍订购号、带有适当商标符号的公司名称、版权符号以及表示书籍所有权的措辞,并注明该书在哪个国家印刷的声明。你还会在封底上看到条形码。看看你的软件是否能生成条形码—你只需访问条形码工具并输入书籍订购号,工具就会生成条形码。

标题页

书名页通常是封面的复制,但省略了某些元素。通常被省略的有插图、公司或产品的标志和口号。一些技术出版物完全省略书名页,因为看似是不必要的重复。(在两万册的印刷量中,一页就意义重大!)

版本说明

版次说明通常是技术出版物中最先出现的一段常规正文,尽管其字体通常较小。它位于书名页的背面。如果技术出版商采取精简与环保的做法并省略书名页,版次说明将出现在前封面的内侧。

没人喜欢读小字,但请看看版本说明中通常包含的声明:

免责声明

请参阅有关部分 版本说明,那里通常是免责声明被藏匿的地方。如果一个产品或其出版物需要整整一页来放免责声明,我就不会买它!

商标

尽管许多公司确实在该处列出他们自己的和其他公司的商标 版本通知, 有些人更喜欢把它们列在单独的一页上,就在版次声明之后。 这些放置决定几乎完全属于公司律师的职责范围;作为作者,你可能不得不遵从,无论该决定在图书设计或写作风格方面有多糟糕。 请记住,你只列出出现在该书中的那些已注册商标的产品名称。

你会注意到,有些出版物在商标问题上采取极端做法:他们会在商标产品名称首次出现时,甚至在每次出现时,都用星号或脚注标注。但这些毕竟是公司律师的指示,技术写作者不得不无奈服从,尽管这令人遗憾。

保证

更多法律相关内容。这些是公司将为其产品提供支持的“保证”。有时这些会刊登在书籍的前置材料中;但从书籍设计的角度来看,更合适的做法是将它们印在一张单独的卡片上,并置于书籍或产品的收缩包装内。同样,正如版次声明,这些文本只是作为“样板”引入,并放置在书中适当的位置。

不过,你应该注意,公司有时会保留多个版本的版本声明、安全通告、保修条款、沟通声明等类似内容。作为一名撰稿人,你必须确保使用的是正确的版本(在查明哪个是正确版本的过程中,你还有机会走出去,结识公司里许多新同事!)。 无论如何,千万不要更改这些样板条款的文本,即便它们写得再糟糕。对这些更改通常必须得到公司律师的批准(律师通常会勉强同意,而且只有在你多次努力并且经过很长时间之后才会批准)。

安全注意事项

硬件产品的手册通常在前部有一个安全注意事项部分。例如,这些可以出现在前言的一个子章节中,或者作为一个独立的章节。这些章节通常将整本手册中出现的所有危险、警告和注意事项汇集在一起,并以某种逻辑方式进行排列。但即便有了这样的前部提醒,硬件手册仍会在各个适用的地方放置具体的注意事项。(有关更多信息,请参见 特别通知.)

沟通声明

硬件手册还需要包含由产品运往国家的政府所规定的通信声明。在美国,联邦通信委员会(FCC)要求根据硬件产品的“类别”提供特定的通信声明。作为撰写者,你必须注意为你正在记录的产品—使用正确的通信声明,并且不得以任何方式编辑该声明(这些可都是神圣的法律用语!)。

目录

目录(TOC)通常至少包含第二层级的详细信息(即实际正文中的一级标题),以便读者能够更精确地找到所需内容。作者、编辑和书籍设计师通常会就目录的排序进行争论。从可用性角度来看,最好将目录尽可能靠近书的前部,甚至放在书的最前面。然而在法律层面上,人们又担心所有那些沟通声明、保修条款、版权、商标和安全通知应该排在最前面。在可用性占上风的情况下,书籍会用尽各种手段把这些法律性材料从前置内容中移走:保修条款被放在单独的卡片上并与书籍或产品一起收缩包装;保修、沟通声明、商标等可能会被放入附录中。

难以创建格式良好的目录?请参见 创建一个专业外观的目录

插图目录

为普通用户撰写的技术手册通常没有图表目录。事实上,图表本身通常也没有完整的图表标题。但这并不意味着图表目录在技术手册中没有用武之地。这一切都取决于读者及其需求—以及书的内容。如果书中包含表格、插图、图表、曲线图及其他读者可能想要直接查找的内容,那么图表目录是适当的。

前言

序言的功能是使读者为阅读本书做好准备。它通过以下方式实现:

在传统图书出版中,前言位于目录之前;但正如先前在……中讨论的那样 目录 在该部分,技术出版人员希望目录(TOC)在书中更靠前,出于可用性原因。

正文章节

哦,对了,这些书里确实有实际正文—并非全是前置内容!在这里没什么别的可说,除了大多数技术书籍都有章节或小节,而且在某些情况下还有部分。参见有关章节 页面设计 用于解决诸如页眉、页脚、标题、列表、通知、表格、图形、交叉引用和突出显示等元素的格式、样式和设计问题。

附录

正如你所知,附录用于放置那些似乎不适合放在书的正文部分但又不能从书中删去的材料。附录通常是放置庞大笨重表格的地方。一些技术出版物会在附录中包含保修等内容。 在格式上,附录就像一个章节—,只是它被命名为“附录 A”或类似名称,页眉和页脚也符合那种不同的编号和命名约定(附录 A 的页面为 A-1、A-2 等)。

术语表

一些技术出版物包括一节专门术语及其定义。注意,大多数词汇表使用双栏布局。通常,每个术语及其定义构成一个单独的段落,术语采用小写(除非是专有名词)并以粗体显示,后面跟一个句号,然后以常规罗马体给出定义。还要注意,定义通常不是完整的句子。良好的词汇表定义应使用如……中所述的正式句子定义技术 定义章节 本在线文本的。多个定义通常用括号中的阿拉伯数字来标识。术语表段落还包含 看见 对首选术语和的引用 另见 对相关术语的引用。

索引

索引通常也是双栏的,并且还包含 对首选术语的引用和 另见 对相关术语的引用。参见关于 索引 用于创建良好索引的流程和指南。

读者反应表格

在互联网和社交媒体兴起之前,一些技术出版物随书附有纸质表格,便于读者提交评论、提问以及对本书的评价。当然,事实证明,这些表格更常被用来引出对书中所记载产品功能故障的投诉。随着互联网的兴起,这些表格已转为线上形式,书籍只是指向它们在网上的位置。

书籍设计与排版

通常由硬件和软件制造商制作的用户指南和手册设计得相当朴素和简洁。高科技公司有时每九个月就会开发和发布其产品的新版本。在这种情况下,复杂的设计并不实际。下面是你会看到的一些典型布局和设计特征:

注意: 本次关于印刷书籍的讨论到此结束。 组件. 要完成本印刷图书设计概述,请参阅有关……的章节 页面设计,涵盖 元素 例如页眉和页脚、标题、列表、特别说明、表格、图形、突出显示、交叉引用等。


我会感激你对本章的想法、反应和批评: 你的回应.