这是我参与「第五届青训营 」伴学笔记创作活动的第 12 天
这篇学习笔记是我在观看学习字节内部课关于通用素质 - 技术写作原理课程的一些简单学习总结
技术写作原理
写好标题
巧用SPA原则，写出精简准确的文档标题
什么是标题
标题：指明文档内容的概括性语句
- 总标题：文档核心内容的体现
- 副标题：对总标题加以补充和解说
- 分标题：文档内的分级标题，能清晰地显示文章的层次
写好标题的原因
- 可提升浏览量，更容易被引用
- 帮助读者快速了解文档的主要内容
如何写好标题
职场写作的标题要符合SPA原则，即简单明确（Simple）、利益相关（Profit）、准确客观（Accurate）。
简单明确（Simple），就是要做到形式简单，观点明确。形式上简洁精练，控制字数，只保留核心关键字。标题应该是一个明确结论，以做到“结论先行”。通过标题，读者能清楚地知道你的立场和观点。
利益相关（Profit），就是要做到利益相关，引起注意。利益相关是最重要的，也是最难做到的。这里的利益是指对方关注的利益，要找到这个利益点，一方面要换位思考，从对方的角度考虑问题；另一方面要深刻全面地了解对方。
准确客观（Accurate），就是要做到实事求是，符合事实，不夸大其词，不过多表达主观情绪，这是最基本的要求。同时还要注意“以上统下”，标题是对所有内容的终极提炼，如何用有限的字数概括出全文的核心观点和本质内容，需要强大的抽象思维能力。
极简写作
学习如何用精简有力的语言来传递内容
极简写作的概念
- 简化读者理解信息的成本
- 用最精炼的语言概括最有价值的信息
采用极简写作的原因
- 节省时间
- 易于理解
- 减少成本
如何极简写作
- 保存一致：
- 最简单，最易忽略
- 避免啰嗦：
- 简化效果最直观，需在长期写作训练中习得
- 提供路标和索引：
- 方式多样
检查文档
360度全方位检查文档内容，持续提升文档质量
什么是检查文档
对文档的“体验”
- 写作：
- 以创作者视角表达和呈现信息
- 检查：
- 以批判者视角审视已经写好的内容
如何检查文档
我们可以从主题，结构，标题，内容四个方面来检查文档
主题
- 主题是否明确且聚焦，且符合目标读者的需求
- 内容是否过于发散，是否有跑题
结构
- 内容是否遵照一定逻辑顺序
- 是否符合结构化写作原则：结论先行，以上统下，归类分组，逻辑递进
标题
- 是否符合SPA原则(简明扼要，利益相关，准确客观)
内容
- 文字表述是否简单清晰，不“拖泥带水”
总结
文档写作流程
-
写作前
- 了解读者
-
写作中
- 结构化写作
- 写好标题
- 极简写作
-
写作后
- 检查文档
