请点击这里以获取帮助 大卫·麦克默里 支付他的网络托管费用:
捐赠您可以的任何小额款项!
在线技术写作将继续免费。

标题措辞

较长文档的标题,如正式技术文档、用户指南和白皮书,有时过于简短。例如,如果技术文档的标题是“塑料污染报告”,那么该文档可能超过300页。如果标题改为“塑料回收方法的评估”,那么该文档或许会更易于管理。

当然,你不希望一个文件的标题是约翰·弥尔顿这位英语诗人在1641年创作的那个: 关于英国教会纪律的改革:以及迄今为止阻碍它的原因。两本书,写给朋友.

想想你可以针对每个主题说的所有事情!重要的是,读者从这样的标题中根本无法知道你要真正涉及什么。

标题措辞的要素

当您为文档制作标题时,请考虑指明这些元素,但不要创建一个段落长的标题:

请注意,创建一个具体、聚焦的标题的过程类似于 缩小主题在其他地方已涵盖。

标题措辞示例

考虑这个标题: 纳米技术:医疗应用概述巨大的话题 纳米技术 确实已说明,但请注意它已缩小到 医疗应用 和范围元素被应用—概述.

注意前面例子中冒号的使用。这可以让你减少用词。另一个可能性是 纳米技术的医学应用:概述.

问题标题措辞

技术文档的一个常见问题是标题过于笼统和模糊,例如:

纳米技术报告
埃博拉报告
智能手机报告
关于太阳能的报告
关于石墨烯的报告

标题页面设计与格式

这一章关于 技术文档设计 提供了一个相当简约的标题页概念,如左侧所示。然而,许多技术文档在标题页中包含了美丽的图像,如右侧所示:


我很想听听你对这一章的想法、反应和批评: 你的回应大卫·麦克默里.