如何写作第三课:写好标题

《如何写作通用教程》将通用写作拆解成五个部分,总结了在写作前写作中写作后三个阶段需要注意的写作要点和技巧,通读整个系列文档,可以帮助你搭建系统的技术写作知识体系。

第一章:何为标题

标题是指明文档内容的概括性语句,标题一般分为总标题、副标题和分标题三类。各类文章的标题,样式繁多,但无论是何种形式,都是为了体现文档所涵盖的主旨及核心,是对所有内容的终极提炼。

文档的标题可以分为:总标题、副标题分标题。不同的标题在一篇文档中会起到不同的作用:

  • 总标题:文章核心内容的体现。
  • 副标题:对总标题加以补充和解说。
  • 分标题:文档内的分级标题,能清晰地显示文章的层次。一般会标明"一、二、三"等的顺序,起承上启下的作用。分标题的撰写需要紧扣所属层次的内容,以及上文与下文的联系紧密性。

第二章:为何写好标题

什么是好的标题?在措辞上,一个好标题一定是精简凝练的,能一下子抓住读者的注意力。有学术研究显示,标题简短的文章浏览量大于标题冗长的文章,同时也更容易被引用。此外,在内容上,好的标题一定是准确清晰的,能帮助读者快速了解到文档的主要内容,从而判断是否要打开你的文档。

第三章:如何写好标题

标题设计可以遵循 SPA 原则

  • 简明扼要(Simple): 标题不宜过长(建议控制在10个中文字以内),只保留核心关键字。
  • 利益相关(Profit) :利益指的是标题要体现目标读者所关注的内容,即读者切实感兴趣的点。
  • 准确客观(Accurate) :不宜过多表达主观情绪,在字数有限的情况下概括出全文核心本质,而概括全文便是运用了结构化思维中的"以上统下"。

第四章:如何使用标题公式

标题一般由特定的元素构成,其撰写方式有一定公式可借鉴。以下几种符合SPA原则的中文标题公式:

  • 概念型文档:介绍某一个概念,内容可以是介绍背景、原理以及优劣势等。

    • 名词+名词,如《xxx 概述》、《xxx 背景》、《xxx 原理》等。
  • 任务型文档:指导完成某项具体的任务,内容通常包括业务背景、前置条件、操作步骤、验证结果以及注意事项等。

    • 主题词+动词,如《A 工具的安装》、《A 工具的部署》等。
    • 动词+主题词,如《配置 A 环境》、《部署 A 环境》等。
  • 参考型文档:罗列参考信息,比如产品的型号参数、API参数以及配置参数等。

    • 介词+定语+主题词,如《对机器配置的要求》。

第五章:小结

本次课程介绍了标题的分类,包括主标题、副标题和分标题。同时介绍了一个好标题的重要性,一个精简凝练、准确清晰的标题能让读者快速了解文档的核心内容。要写好一个标题,我们可以遵循三个原则,分别是 简明扼要、利益相关准确客观。最后我们还分享了几种常见类型文档的标题模版,同学可以在撰写文档的时候直接套用这些模版,达到事半功倍的效果。

相关推荐
张同学034 小时前
220V 转 12V/5V 电源输入电路设计笔记
笔记·嵌入式硬件·硬件工程
深蓝海拓4 小时前
S7-1500PLC学习笔记:MOVE_BLK、MOVE_BLK_VARIANT、BLKMOV的区别
笔记·学习·plc
雨浓YN6 小时前
OPC UA 通讯开发笔记 - 基于本地dll文件
windows·笔记
深蓝海拓6 小时前
S7-1500学习笔记:用户自定义数据类型(UDT)
笔记·学习·plc
罗罗攀7 小时前
PyTorch学习笔记|神经网络的损失函数
人工智能·pytorch·笔记·神经网络·学习
tq10868 小时前
价值:社会对劳动所产生的效用增量形成的局部共识
笔记
A923A9 小时前
【小兔鲜电商前台 | 项目笔记】第八天
前端·vue.js·笔记·项目·小兔鲜
猹叉叉(学习版)10 小时前
【系统分析师_知识点整理】 15.数学计算与知识产权
笔记·软考·知识产权·系统分析师
風清掦12 小时前
【江科大STM32学习笔记-10】I2C通信协议 - 10.1 软件I2C读写MPU6050
笔记·stm32·单片机·嵌入式硬件·物联网·学习
MwEUwQ3Gx12 小时前
常见Linux权限提升笔记
linux·运维·笔记