meta charset="UTF-8"> 在线技术写作:交叉引用

请点击这里以获取帮助 大卫·麦克墨里 支付网页托管费用:请随意捐赠任何金额!
在线技术写作将继续免费。

技术报告和说明通常需要交叉引用—这些指向同一文档中其他地方或其他信息来源的指针,在那里可以找到相关信息。

交叉引用可以以多种不同方式帮助读者:

  • 如果他们进入了一个超出自己理解范围的文件,它可以引导他们找到更基本的信息。
  • 如果他们已经知道你想告诉他们的内容,它可以指向更高级的信息。
  • 此外,它还可以指引他们找到相关信息。

相关信息是最难解释的领域,因为最终一切都是相互关联的—交叉引用可能没有尽头。这里有一个来自DOS的例子—那个潜伏在PC类型计算机内并据说能帮助你的怪物。有几种方法可以复制文件:COPY命令、DISKCOPY命令和XCOPY命令。每种方法都有不同的优点。如果你正在写关于COPY命令的内容,你会希望有指向这另外两个命令的交叉引用,以便读者可以进行一些比较。

当然,上面的讨论假设引用的是同一文档中的交叉引用。如果你的文档中需要涵盖的背景信息实在太多,你可以引用一些提供该背景的外部网站、书籍或文章。这样,你就可以免于解释所有内容了!

交叉引用的组成部分

交叉引用可以是 内部 (在同一文档内)或 外部 (在当前文档之外)。大多数交叉引用指南取决于交叉引用是内部还是外部。. 对于外部来源,您无法控制书籍、章节、标题、页码。它们可能会有所变化!

带有对外部文件的交叉引用:

  • 不要逐字引用书名、章节或标题。相反,请提及所涵盖的主题。
  • 不要引用确切的章节或节号或确切的页码。

现在,一个良好的交叉引用包含几个要素:

  • 引用的来源名称—这可以是标题或一般主题参考。如果它是章节标题或小标题,请加上引号;如果它是书籍、杂志、报告或参考作品的名称,请用斜体书写。(个别文章标题也需加上引号。)
  • 页码—如果在同一文档中则是必需的。如果交叉引用指向章节的开头,并且引用了章节号和标题(无论内部还是外部),则不需要页面号码。读者可以使用目录。如果交叉引用包括编号章节内部的标题,请包括该标题出现的页面号码。
  • 交叉引用的主题—通常,您需要说明交叉引用材料中的内容,并指出读者为什么应该花时间查看它。这可能需要指明交叉引用材料的主题或明确说明它与当前讨论的关系。

这些指导方针在下图中展示。请注意,在该图中,当交叉引用是 "internal"(也就是说,指向同一文档的其他部分)时,规则有多么不同,和当它是 "external"(指向文档外的信息)时的不同。

交叉引用示例

内部交叉引用是指对同一文档内其他区域的引用;外部交叉引用是指对文档外信息资源的引用。

内部与外部交叉引用示例
例子 有关创建图形并将其纳入文档的详细信息,请参见本指南第16页的图形部分。
解释 在此内部交叉引用中,部分内容被一般性地引用。内部交叉引用时引用页码是标准做法。
例子 有关创建图形并将其纳入文档的详细信息,请参见在线技术写作指南中的“图形”部分。
解释 章节标题用双引号括起。章节所在书的书名用斜体表示。
例子 有关创建图形以及如何将其纳入文档的详细信息,请参阅图形章节。 在线技术写作指南.
解释 如果你不想引用章节的确切标题,可以使用小写字母。
示例 有关创建图形并将其纳入报告的详细信息,请参阅“让每月报告更精彩!” 办公室信息通讯.
解释 如果您引用期刊中的一篇文章,请将文章放在引号中,并将期刊名称斜体显示。

交叉引用中的说明性措辞

遇到这样的交叉引用是无益且烦人的: (见图 3)

读者需要知道交叉引用材料的内容,以及他们为什么应该去查看它。

他们还需要一个简要的了解,如何理解内部的交叉引用文本、图像、表格、图表或图示—只是一个提示。这里有一个例子(交叉引用文本的背景已添加灰色):

锂通过两种主要方法提取:传统的露天矿采矿技术和卤水提取[6]。如图3所示,花岗岩矿石占全球锂资源的26%,而卤水占66%[6]。

explanation of this image will be supplied 图3. 全球锂储量按类型的百分比 [6].
图表的解释性交叉引用示例。 请提供要翻译的文本。 詹姆斯·鲍尔。

一旦蒸发池中的盐水达到了理想的锂浓度,盐水就会被抽送到锂回收设施进行进一步加工和提取。剩余的盐水溶液则被返回到地下水库。 图5显示了一个典型锂蒸发池系统的规模。请注意道路和电线杆的大小以作尺度参考。

explanation of this image will be supplied
图5. 锂蒸发池 [10].
解释性交叉引用的示例。 请提供要翻译的文本。 詹姆斯·鲍尔。

这是另一个例子;灰色背景在原文中并不存在:

露天采矿。 花岗岩岩石通过传统采矿技术从露天矿坑提取。提取的花岗岩块随后被机械破碎以减少其尺寸。破碎的矿石进一步磨碎以生产更细的产品,这更适合进一步分离。加工结果产生一种浓缩物,经过化学处理以生成碳酸锂或氢氧化锂[3]。 图4提供了一个露天锂矿的例子,展示了这些操作的典型规模。

explanation of this image will be supplied
图4. 露天锂矿 [7].
解释性交叉引用示例。 来源: 詹姆斯·鲍尔。

相关信息

阅读测验使用这个测验来测试你对本章的理解。

提供培训. 练习写作 麦克默里 作为你的导师。


我很想听听你对这一章的想法、反应和批评: 你的回应.