??? 文档标题和标题页

请点击这里以获得帮助 David McMurrey 付他的网站托管费:
捐赠你能出的任何小金额吧!
Online Technical Writing akan kekal percuma.

标题措辞

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

当然,你不会想要一个文件的标题是约翰·米尔顿,这位英诗人于1641年创作的作品: 关于英格兰教会纪律的改革:以及迄今为止阻碍其改革的原因。两本书,写给朋友.

Just think of all the things you can say about each of these topics! It’s also important to note that readers won’t really know from these titles what you are going to cover.

标题措辞的要素

When you create a title for your document, think about including these elements but avoid making it a paragraph long:

  • Please provide the text you would like me to translate. 你的文档主题可以类似于以上那些例子。但不要止步于此—你还有更多工作要做。
  • 范围: 范围是指你在主题上关注的宽广或狭窄程度。范围和概述并不总是容易区分。元素 概述 表示对该主题某个方面的一般评审。
  • 概况: As the term is used here, overview refers to a listing of the main subtopics to be covered. True, it is contradictory to how the term is used to define scope. Not to worry, this is not science. A good example of this use of the term is this: Ebola: Penyebaran, Gejala, Rawatan. 最后三个词是清单。

请注意,创建一个具体、专注的标题的过程与以下过程相似 缩小主题, 在其他地方提到过。

Title phrasing examples

请考虑这个标题: 纳米技术:医疗应用概述. The giant topic 纳米技术 确实有提到,但注意它被缩小至 perubatan aplikasi dan satu elemen skop digunakan—概述.

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

Masalah tajuk penyebutan

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

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

封面设计与格式

The chapter on techdoc reka bentuk 呈现出相当简约的标题页概念,如左侧所示。然而,许多技术文档在标题页中包含了美丽的图像,如右侧所示:


I would like to know your thoughts, reactions, and feedback on this chapter: Your responseDavid McMurrey.