技术写作原理03 - 写好标题| 豆包MarsCode AI 刷题

159 阅读2分钟

写好标题

大家可能会有一个惯性思维,认为写文档的第一步是给文档起一个标题,但在实际的写作过程中,写作的内容常常会随着思考的深入而不断地改动,那么这时候一开始撰写的标题可能就无法准确概括出当前文档的核心内容了。

因此最好就是在文档有了稳定的框架和内容之后,再去提炼整篇文档的核心,为文档起一个简洁凝练的标题,做到一步到位。

为什么要写好标题

  • 可提升浏览量,更容易被引用。
  • 帮助读者快速了解文档的主要内容。

标题都有哪些

  • 总标题 : 文章核心内容的体现
  • 副标题 : 对总标题加以补充和解说
  • 分标题 : 文档内的分级标题,能清晰地显示文章的层次,一般会标明 1,2,3 的顺序

好的标题一定是准确清晰的,能帮助读者快速了解到文档的主要内容,从而判断是否要打开这篇文档,要是标题写的不够好,可能读者也就不愿意打开这篇文档了

如何写好标题

image.png

S1mple:标题简明扼要,不宜过长,建议控制在10个中文字以内

Profit:体现读者关注的点,简洁的表明该文档的特点

Accurate:不宜表达过多主观情绪,在字数有限的情况下概括出全文核心本质,而概括全文则是运用结构化思维中的以上统下

这里推荐几种符合 SPA 的中文标题公式

文档类型描述示例
概念型介绍某一个概念,内容可以是介绍背景、原理以及优劣势等。名词+名词,如《A 概述》《A 背景》、《A 原理》等。
任务型指导完成某项具体的任务,内容通常包括业务背景、前置条件、操作步骤、验证结果以及注意事项等。名词+动词动词+名词,如《A工具的安装》、《部署 A 环境》等。
参考型罗列参考信息,比如产品的型号参数、API 参数以及配置参数等。名词+名词,如《机器配置的要求》等。

总结

写好标题

  1. 标题的分类
    • 主标题
    • 副标题
    • 分标题
  2. 标题的重要性
    • 帮助读者快速了解文档内容
  3. 如何写好标题
    • SPA 原则 —— 简明扼要、利益相关、客观准确
    • 参考标题模板