- 这是我参与第五届青训营伴学笔记创作活动的第10天
- 程序员知识输入和知识输出必备的技术写作技巧，本篇文章为了之前写文章一直处于随意发挥的同学。
本文是利用青训营开通的会员特权，抽空学习的字节内部课程。
了解读者
- 搞懂读者从哪来 在哪里 去哪里的问题
- 明确身份（小白 资深用户 运维 开发人员）
- 明确读者目的（了解概念 完成步骤 查阅和参数解释）
- 明确所需信息（根据读者能力提供信息）
搞懂信息差
- 术语 同一篇文档 同一术语
- 相似物 及时作对比
- 新事物 需要充分解释和说明
Eg
结构化写作
- 谋篇布局， 为作者理清思路，为读者降低成本
- 四个步骤：
- 论（结论先行）
- 证（以上统下）
- 类（归类分组）
- 比（逻辑递进）
结构化呈现
- 有序列表
- 无序列表
- 表格
Eg
写好标题
- 更高引用 点名文章主题 巧用SPA原则。
SPA Simple Profit Accurate 简明扼要 利益相关 准确客观
- 总标题：文章核心体现
- 副标题：总标题补充
- 分标题：清晰的文章结构，反应内容之间的联系
极简写作
- 精简有力的语言来传递内容
- 三个原则
- 保持一致
- 避免啰嗦
- 提供路标索引
检查文档
- 360度全方位检查文档，持续提高文档质量
- 写作：以创作者视角表达
- 检查：以批判者角度审视内容
- 检查注意事项
