发现

技术写作对在职开发者的价值

分享和传播知识

知识库建议

技术表达力 -> 提升组织效能,降低沟通成本

学习和掌握知识

费曼学习法 -> 以与代想,以想代讲,以讲难真

沉淀总结项目经验

技术能力成长的助推器

众审,为晋级答辩助力

提升个人和团队技术影响力

扩大影响力

反哺业务发展

探索

一篇优秀技术文章的必备要素

什么是”好”的技术文章?

基本前提:内容无错误信息

• 干货满满
• 专业前沿
• 深入浅出
• 受众面广

特点:内容丰富吸引人,干货多;受众面较广;内容生动有趣;深入浅出;专业前沿;

揭秘

高效技术写作的全流程

写好文章的技巧:

1. 同理心 – 确定目标读者
2. 攒素材 – 积累文章素材
3. 定好题 – 确定文章主题
4. 搭骨架 – 确定文章结构
5. 画好图 – 绘制文章配图
6. 有干货 – 提升文章内容
7. 勤润色 – 反复润色文章
8. 练内功 – 扩大阅读范围

知识的诅咒

读者不是自然人,而是需求的集合

不要只适合组内同学看

• 摒弃限定上下文的信息
• 通用的技术方案和思考
• 最大程度扩大受众面

“零基思维”, 站在读者的角度思考

请清楚”是什么,为什么,怎么办”

找没有背景的同学检验

攒素材

项目周期太长,思考脉络早已遗忘

碎片化记录,结构化整理

思辨

以终为始,写好设计文档

• 平时记录思考过程,多思辨
• 认真写设计文档
• 参考同类文章
• 请教技术专家

定好题

意在笔前

语之所贵者意也

• 工作总结 – 及时记录
• 学习材料 – 找准角度
• 观察生活 – 细致观察
• 巧用对比 – 辨证思维
• 深挖本质 – 逻辑思维
• 热点话题 – 关心时事

什么话题值得写

• 有分享欲才写
• 文以稀为贵
• 对他人有价值

搭骨架

先写什么,后写什么,怎么开关,怎么结尾

先确认目录(结构)

— 金字塔原理, 四大原则

• 结论先行 – 先提出总结性思想自上而下的表达;
• 以上统下 – 自下而下的思考总结概括
• 归类分组 – 每组中的思想需要属于同一个范畴
• 逻辑递进 – 每组中的思想都需要按逻辑顺序组织

————-

• 观点先行: 在导语和开篇中就亮出观点,吸引读者
• 先有提纲: 先列目录,再写内容
• 承上启下: 每个段落之间做合适的过渡和转换
• 结尾升华: 在文章末尾总结全文,升华主题,拓展思考

写着写着写不下去了,或者跑题了

结构化思维

结构化思维的本质是信息熵,把知识的有序度最大化

结构化思维训练不足

• 自上而下: 观点 – 事实 – 数据
• 层次浅析: 一个章节内说清楚相关议题,分清楚议题的层次
• 结构简单: 表达结构不宜太过复杂, 重要的事情说3点
• 重点突出: 不要传递过多信息, 要把最想传递的信息突出出来

s1. 头脑风暴 – 把所有想法穷举

s2. 把穷举后的想法分类归纳

s3. 基于分类提炼标题

s4. 做一些补充

画好图

文不如数

数不如表

表不如图

人脑处理图片的速度是处理文字的60000倍

一图胜千言

有干货

1.更高的抽象层次,尽量避免描写过多技术细节,上升为方法论

2.专业性,在自己熟悉的专业领域写作,避免传达错误信息

3.有深度,体现在领域的全面掌握

4. 加入基于自身实践的理解

勤润色

语言 – 精简,准备, 生动

章节 – 章节连贯,过渡自然

排版 – 不同级别标题,不要超过3层; 句子不要太长, 不要有错字

把复杂的东西讲简单, 把简单的东西讲深刻, 都是比较难的事情

练内功

多看各种技术论坛