《技术写作指南》阅读笔记

本文为掘金小册《技术写作指南》阅读笔记。

这本小册的作者为张鑫旭，主要内容是介绍如何进行技术写作。

因为日常搜前端开发的问题，基本上都会搜到他的文章。出于好奇，我买下了这本小册子，并打算读一下。

以下是阅读笔记。

为什么要进行技术写作

• 技术成长
• 工作机会
• 意外收获

写作经验与技巧

选择合适的写作平台

• 公共平台
• 自建平台

写什么？

• 确定写作方向
  • 与本职工作相关
  • 专注于垂直领域
• 确定写作选题
  • 新方法、新特性、新技术
  • 日常工作中的小技巧，小创新（建议多写）
  • 深入理解XXX，XXX原理剖析（建议多写）
  • 技术实现方案综述、技术选型对比
  • 体现技术深度的棘手问题解决（建议多写）
  • 框架、工具、会议体验指南不指北
  • 外文翻译
  • 技术资讯与技术人文
• 确定写作内容
  • 参考文档
  • 固定素材
  • 订阅周刊
  • 随便逛逛
  • 工作实践

我们的写作目的要么为了个人成长，要么为了脱颖而出，精力有限，时间有限，所以一定要专注在某个垂直领域，让自己的付出价值最大化。

搭建文章的框架结构

• 具体的写作套路
  • 技术科普
  • 原理剖析
  • 功能实现
  • 使用教程
  • 问题解决
  • 项目总结
  • 会议记录（各种技术沙龙、技术峰会等）
  • 工具测评
  • 技术人文
  • 职场故事
• 没有固定的套路
  • 不同的账号主体
  • 不同的阅读对象

制作配图及相关素材

• 代码片段
• 辅助图片
• 演示视频
• 在线案例

写出有吸引力的内容

• 稀缺如今
• 形式创新
• 角度新颖
• 棱角个性
• 换位共情
• 内容严谨
• 技法高明
• 保持真心（创作的真心）

品牌运营与传播技巧

品牌运营：

• 账号名称与头像
• 强化文风与措辞
• 保持棱角
• 负面评论的处理（当你的文章数量足够多，读者群体也足够大的时候，一定会收到负面评论。—— 无视才是最好的反击）
• 防盗技巧
  • 版权声明（很多都是直接抓取的，把版权信息带上还能带来回流）
  • 图片水印
  • 内容植入（防盗效果最好）
  • 软安利（把自己的作品以安利方式植入！）

传播技巧：

• 专业社区有专业的编辑，只要你持续用心创作优质内容，编辑大大们会给你曝光位的，这是一种合作关系，勇敢沟通，努力争取，无需客气
• 如果是公众号这样的平台，则需要自运营，通过朋友圈逐渐发酵传播，前期速度肯定快不起来
• 公众号阅读通常利用的是碎片时间，因此，短平快的文章往往会获得更高的关注与转发
• 无论是哪个平台发布作品，都不要在周末和节假日发布推广（因为周末大家的心思都不在学习上，发布的文章没什么人看的）
• 如果是深度好文，其传播往往是通过质量与口碑，讲求长尾，时效性要求不高
• 如果是比较浅显的技术知识或技术资讯传播，推荐在上午 9 点之前发布，最晚不超过 10 点，因为早高峰上班是普遍学习热情最高的时候
• 工作日的午饭和晚饭时间也有一定的访问量

如何坚持下去

为什么你无法坚持？

• 病理性原因（常见如抑郁症，表现为对什么事情都不敢兴趣，包括看剧、游戏、娱乐这类放松休闲的活动，整个人充满无力与忧伤，喜欢阴天，喜欢放空自己）
• 动力不足（本质上是因为类似写作和学习这样事情缺少短期激励，无法及时带来满足感和愉悦感）

如何坚持下去？

• 告别苦尽甘来的心理（正确的做法一定是：甘苦并存，螺旋上升）
• 获得正反馈
  • 内容（精心选择创作的内容，避免纯输出无成长的内容；给创作寻找乐趣）
  • 形式（多多奖励自己；学会任务分解；敢于放纵自己）
  • 精神（锻炼延迟满足的能力；从他人那里汲取能量）

时间和精力：

• 大家是不是对“没时间”有什么误解（有一部分人，把工作和生活区分得很开，心里面有一个工作时间账户，还有一个生活时间账户）
• 为了更好的生活（工作是为了什么？为了更好的生活，想要摆脱现在的困境，少点娱乐，多点学习，一点也不过分，况且本身就是个稳赚不赔的买卖）
• 金钱换时间换更多的金钱（你的一生中，最宝贵的就是时间，什么时候你能学会花钱买时间，你就走在了快速上升的阶梯上了）

让自己的作品价值最大化

• 抓住版权
• 多平台经营
• 内外开花
  • 作品价值最大化做法：文字作品 -> PPT分享 -> 视频讲解
  • 由于大多数人都是兼职写作，因此 作品内容价值最大化的场景并非是外部平台分发，而是在公司内的传播
• 微创作
  • 技术 Tips（所谓技术 tips，指的是那些一两句话就能描述清楚的专业技能或知识）
  • 思考想法（领导特别喜欢看到下面的人有自己的想法和思考，这个想法可以针对自己的专业，可以针对公司的产品，也可以是对个人成长的思考）
  • 委婉暗示（这也是对职业发展很有帮助的写作技巧，更准确地说，是某种意识的点拨）
• 体系化创作（量变产生质变，当你的作品数量积累到一定程度之后，这些作品是可以进一步包装，进行二次销售的，这个在创作圈子中很常见，甚至有的书籍直接就是博客精选文章合集）

参考

• 掘金小册《技术写作指南》