《技术写作指南》:写作经验与技巧
· 阅读需 5 分钟
本文为掘金小册《技术写作指南》阅读笔记,作者张鑫旭,主要内容是介绍如何进行技术写作。
因为日常搜前端开发的问题,基本上都会搜到他的文章。出于好奇,我买下了这本小册子打算读一下,并输入阅读笔记。
为什么要进行技术写作
- 技术成长
- 工作机会
- 意外收获
写作经验与技巧
选择合适的写作平台
- 公共平台
- 自建平台
写什么?
- 确定写作方向
- 与本职工作相关
- 专注于垂直领域
- 确定写作选题
- 新方法、新特性、新技术
- 日常工作中的小技巧,小创新(建议多写)
- 深入理解XXX,XXX原理剖析(建议多写)
- 技术实现方案综述、技术选型对比
- 体现技术深度的棘手问题解决(建议多写)
- 框架、工具、会议体验指南不指北
- 外文翻译
- 技术资讯与技术人文
- 确定写作内容
- 参考文档
- 固定素材
- 订阅周刊
- 随便逛逛
- 工作实践
我们的写作目的要么为了个 人成长,要么为了脱颖而出,精力有限,时间有限,所以一定要专注在某个垂直领域,让自己的付出价值最大化。
搭建文章的框架结构
- 具体的写作套路
- 技术科普
- 原理剖析
- 功能实现
- 使用教程
- 问题解决
- 项目总结
- 会议记录(各种技术沙龙、技术峰会等)
- 工具测评
- 技术人文
- 职场故事
- 没有固定的套路
- 不同的账号主体
- 不同的阅读对象
制作配图及相关素材
- 代码片段
- 辅助图片
- 演示视频
- 在线案例
写出有吸引力的内容
- 稀缺如今
- 形式创新
- 角度新颖
- 棱角个性
- 换位共情
- 内容严谨
- 技法高明
- 保持真心(创作的真心)
