学习笔记:技术写作原理(三)写好标题|青训营;

193 阅读1分钟

要想写好标题,我们首先要知道什么是标题。

写好标题

标题的定义

标题是指明文档内容的概括性语句。

标题的种类

  • 总标题:文章核心内容的体现。
  • 副标题:对总标题加以补充和解说。
  • 分标题:文档内的分级标题,有助于梳理文章的层次。

在我看来,这三个标题可以说是层层递进的,来帮助读者更好地理解文章的内容。在检索时,可以先根据总标题锁定要阅读的文章,之后根据副标题找到文章的侧重点,再借助分标题的内容梳理整体文章行文思路,更好地吸收文章中的知识。

写一个好标题的原因

  1. 提升浏览量,更容易被引用。
  2. 帮助读者快速理解文章内容。

写一个好标题的方法:SPA

  • 简明扼要Simple
  • 利益相关Profit
  • 准确客观Accurate

明确文档类型

类型描述示例
概念型介绍某一个概念,包含背景、原理、优劣势等等。名词+名词《?原理》《?背景》《?概述》等。
任务型直到完成某项具体任务。包括项目背景、前置条件、操作步骤、验证结果、注意事项等。名词+动词、动词+名词《?安装》《部署?环境》
参考型罗列参考信息,比如产品型号参数、API参数以及配置参数等。名词+名词《?的配置参数》

写好标题小结

最后不要忘了总结性语句。

(未完待续)