掘金小册《技术写作指南》（学习笔记）
掘金小册《技术写作指南》（学习笔记）
声明：本文内容来源于掘金小册《技术写作指南》，仅供非商业用途或交流学习使用，如有侵权请联系删除
前言
前两天购买了掘金小册《技术写作指南》，阅读完，有些启发，于是将内容整理成了学习笔记，收纳在我的技术笔记仓库里，笔记链接点这里。
记笔记是因为自己一直有这样的习惯，且便于后面快速回忆。内容上我根据自身的写作特点作了一些微调，并且经过整理后，内容也相对较干，所以还是建议你去阅读一下原文。
（下文中的"我"，均指原作者）
1、开篇：十年技术写作者的收益“清单”
写作收益
1、工作机会
由于写作的原因，09 年底我收到了淘宝 UED 的面试邀请，因为面试官从我的文章中看出我是一个很有研究精神的人。
2、技术成长
写作后，你会进入这个一个良性的循环中：用心写作→技术提高+关注提高→更加用心写作→技术更好+关注度更高→……不断循环。
3、婚姻大事
因为写作，从备胎四号逆袭，与老婆走进婚姻殿堂。
4、额外收益
广告收益、有流量后带来的内推收益、书籍写作销售加成。
2、准备：认清现实，找准定位
欲速则不达
不要模仿他人，一定要将自己的目标和自身的特相结合，让自己的心理和生理状态都准备好，这样，才能事半功倍。
你预期的写作收益是什么？
A. 我希望通过写作获得流量，从而变现搞钱；
B. 我希望通过写作收获影响力，助力职业发展；
...
准确的自我认知
1、如何看待付出与回报？
写作是一件非常具有代表性的高付出低回报的事情，如果写作者急功近利，妄想短短一段时间就能名利双收，绝对成不了事。
2、你喜欢写作吗？
写作出类拔萃之人除了喜爱写作之外，还有一些公共的性格特质，例如偏安静、偏内向、喜欢阅读、爱观察思考、体验深刻细腻。
好在从事技术开发的人大多与这些特质相符，因此，大家都有成为优秀创作者的潜力。
3、你的能力强吗？
如何判断一个人的通用能力强不强呢？很简单，回顾一下，自从成年之后，有没有独自完成一件很棒的事情，任何事情都可以，还是说做什么事情都不顺利？
对于技术写作，我认为最重要的通用能力就是毅力。
逐渐清晰的道路
大家一定要认清现实，想要通过技术写作功成名就的难度非常大，因为前期的收益都是隐性的。
3、准备：选择合适的写作平台
公共还是自建？
自建平台首发，公共平台引流，活用各自的优点。
选择哪个公共平台呢？
如果你发布的内容颇有技术深度，则以掘金、知乎、InfoQ 等平台为主，微信公众号其次；
如果你发布的内容看一眼就能学会，则微信公众号、头条号还有百家号这类偏咨询的平台更适合。
使用哪个自建平台呢？
完全自建的平台，一是备案困难，二是没有流量。
半自建平台，首选 Hexo，也可以选选择 WordPress。
4、技巧：总是不知道该写些什么，怎么办？
第一步，我们需要确定写作的方向，确定好方向后，再在其中确定适合自己的选题，选题确定好之后就可以进入细节和技巧层面。
确定写作方向
1、与本职工作相关
首先，写作的内容是自己熟悉擅长的领域；其次，写作对于技术的学习很有帮助，于是就会形成对事业有帮助的正反馈，可以让你更容易坚持。
2、专注于垂直领域
写作不要每个技术方向都插上一脚，那必然是泛泛而谈的一篇文章。所有一定要专注在某个垂直领域，让自己的付出价值最大化。
确定写作选题
我大致将技术写作的选题分成了下面八类：
- 新方法、新特性、新技术；
- 日常工作中的小技巧，小创新；
- 深入理解XXX，XXX原理剖析；
- 技术实现方案综述、技术选型对比；
- 体现技术深度的棘手问题解决；
- 框架、工具、会议体验指南不指北；
- 外文翻译；
- 技术资讯与技术人文。
2、3、5 类建议多写。
确定写作内容
1、参考 API 文档介绍新特性的文章
2、固定素材
例如，Chrome每隔一段时间就会发布新版，每次发布新版都会有一些对应的特性更新，是不是可以撸一篇文章出来。
3、订阅周刊
周刊的主要成本在于收集，而不生成内容，对时间宝贵之人而言，是非常有帮助。
4、佛系随缘
到处闲晃或者平台写代码时的突然灵感，那么记下来，等有时间写作的时候再拿出来看下。
5、工作实践
自问下面的问题，可以找到写作的内容。
- 这个项目自始至终一帆风顺，没遇到任何困难吗？
- 这个项目有没有用过以前没用过的技术或者实现方式？
- 这个项目有没有引用外部的组件或者工具？
- 这个项目做完之后你一点成长都没有吗？
5、技巧：如何给文章起标题？
内容为王
内容为王，标题的好坏是次要的。
什么是合适的标题？
1、内容跟标题相对应
2、品牌和形象
如果你是一个官方账号，则务必求真务实，不可像个人账户一样为了流量使用博眼球的标题。
个人账号，则文章的标题要和你的个人气质相符合。
3、访问来源
访问来源是平台的信息流推荐，应尽可能地吸引人的注意力，而不用考虑搜索引擎。举例：《花60秒给Vue3提的PR，竟然被尤大亲自Merge了~》
访问来源是搜索引擎，则需要考虑用户搜索的关键字，然后想办法在标题中体现。举例：《JS之我用单img元素实现了图像resize拉伸效果》
借助平台的能力
有的平台（例如头条号）会帮你自动生成多标题，可以省去不知道哪个标题访问量高的烦恼。
6、技巧：如何搭建文章的框架结构？
核心思想
1、连贯性
文字层面的连贯性主要通过关联词保证，分为八大类，包括：并列、承接、递进、选择、转折、因果、假设和条件。
框架层面的连贯，一种是通过结构设计实现，例如：问题背景-问题根因-解决问题-问题总结。另外一种就是使用承上启下的语句强制连贯，例如：上面讲的是ABC，下面再讲下甲乙丙。
2、突出性
脉络清晰：分二级标题、三级标题，让文章结构更加清晰。（移动端可在文章顶部自己建一个目录）
重点突出：第一，要点要在标题中体现；第二、亮点位置尽量靠前；第三、篇幅不能限制重点；
例如：
| 突出技术的架构 | 突出故事的架构 | 突出自己的架构 |
|---|---|---|
| 标题：我遇到的 JS 属性... 这个JS属性可是个磨人的小妖精 欲情故纵，还会玩火 成功激怒了我 深入交流后发现竟然这般甜美 首先她…… 然后她…… 再者她…… 最后她…… 万幸，今天逛了掘金 | 标题：我今天遇到个很棒的事情 今天逛掘金 竟然找到了让我心动的JS属性 怎么回事呢？ 我本来…… 没想到拒绝我 很好，你已经成功地引起我的注意了 我就继续试探 …… 我就说过，你早晚都会是我的 | 标题：看我如何搞定... 这种事情也就我能做到 这个JS属性是个磨人的小妖精 要想拿下可不容易 我就想着…… 于是决定…… 结果却挑战我的底线 不能放弃，再次…… 这下终于…… 看，多么甜美！ 学我，你也可以！ |
内容不同，目的不同，也就决定了突出的重点的不同。
具体的写作套路
1、技术科普
2、原理剖析
这类文章可以遵循由表及里，层层深入的架构策略，方便他人的学习与理解。
3、功能实现
这类文章，我们一定要文中放代码，最后配上演示页面。为了吸引用户继续阅读，通常会把实现好的效果放在最前面，即上面提到的亮点前置。
4、使用教程
这类文章按部就班呈现就可以了。
5、问题解决
如果你是对外创作，则可以根据侧重点不同，微调写作结构。
6、项目总结
这类文章的难点在于如何通过朴实无华的语言透露出项目牛逼、项目人员牛逼。
7、会议记录
这类文章的内容结构也比较固定，就按照时间进行组织就好了。
8、工具测评
为了保证评测中肯可信，可以通过展示使用过程和最终效果来证明。
9、技术人文
这里就单纯地展示下观点类的技术文章的写作结构。
10、职场故事
按照时间线讲好每个时间段的故事即可。
没有固定的套路
1、不同的账号主体
团队账号，以团队的口吻讲述，框架结构要保守，语言也要务实。
个人账号，没有所谓的框架。
2、不同的阅读对象
给同事看的，内容结构应不包装，不夸张，不过谦，展示最真实的情况。
对外发文，要包装成团队的功劳，然后多讲技术实现。
7、技巧：如何制作配图及相关素材？
配图很重要
截图工具：FastStone Capture (Windows)、iShot (Mac)
视频的局限
录屏工具：screenToGif (Windows)、iShot (Mac)
在线演示
（目前发现这个网站可以在线运行代码：1024code.com/）
8、技巧：怎样写出更有吸引力的内容？
稀缺如金
对于技术文章，最醉心的吸引力一定是稀缺性，也就是这些知识、技术、代码只能你写得出来。
形式创新
比如文章中插入时下热点。
要有温度
文章内容要有温度，比如说可以融入情感。
深入浅出
一个知识点尽量深入浅出，让小白也能看懂。
技法高明
1、尽量的口语化，少用书面化的词汇。
2、句式可以灵活多变，语气有强有弱。
比如可以使用疑问、反问这样的句式。
再比如可以使用停顿或重复：注意，注意，注意，重要的事情说三遍，千万不要...
3、善用比喻，学会举例。
比方说“Java 和 JavaScript 的区别就好比雷锋和雷峰塔的区别”这句话就是个经典的比喻，一句话顶得上十句普通的解释。
保持真心
每一篇文章都认真对待，保证文章有所价值的同时更加耐读。
9、技巧：分享品牌运营与传播经验
负面评论的处理
无视才是最好的反击。
防盗技巧
在技术写作中，插入对自己作品宣传的内容，这样，就算文章被盗，也会变相地对你的作品进行了宣传。
传播经验
针对不同的平台的传播规律，我们最好需要对文章进行适当的编辑，使其更利于传播。还有发布时间，也可以根据平台不同适当调整。
10、执行：坚持不下去，怎么办？
为什么你无法坚持？
本质上是因为类似写作和学习这样事情缺少短期激励，无法及时带来满足感和愉悦感。
告别苦尽甘来的心理
正确的做法一定是：甘苦并存，螺旋上升。
如何获得正反馈？
1、内容：精心选择创作的内容，避免纯输出无成长的内容。
2、形式：对于看似艰难的任务，以时间来拆解，从小任务中获得成就感。
3、精神：锻炼延迟满足的能力。
11、执行：没有时间和精力，怎么办？
正确看待“没时间”
有一部分人，把工作和生活区分得很开，心里面有一个工作时间账户，还有一个生活时间账户。
如何管理时间？
制造一个良性循环：努力上进，家人支持，有更多的时间努力上进，带来更大的家庭受益，得到更多支持。
精力获取
玩，是为创作积攒能量。
12、经营：如何让自己的作品价值最大化？
多平台经营
1、作品分发；2、公司内外分发；
在分发的时候，可以适当对内容进行调整。
体系化创作
量变产生质变，当你的作品数量积累到一定程度之后，这些作品是可以进一步包装，进行二次销售的，这个在创作圈子中很常见，甚至有的书籍直接就是博客精选文章合集。