写作技巧和经验
写作技巧和经验
内容总结自：技术写作指南 - 张鑫旭 - 掘金小册，侵删
可选发布平台
- 掘金
- 知乎
- B站 专栏
- 自建博客（主站回源）
确定写作方向和内容
与本职工作相关
专注垂直领域
前端开发就是一个分支特别多的职业，有界面展现、用户体验和无障碍访问方向、有统的逻辑实现和功能开发方向、偏后的 Node.js 开发方向，小程序快应用开发方向、音视频开发方向、SVG/Canvas/WebGL 动效创意表现方向、数据可视化方向、全栈方向，以及前端运维和前端运营方向。
选题：
- 新方法、新特性、新技术；
- 日常工作中的小技巧，小创新；
- 深入理解XXX，XXX原理剖析；
- 技术实现方案综述、技术选型对比；
- 体现技术深度的棘手问题解决；
- 框架、工具、会议体验指南不指北；
- 外文翻译；
- 技术资讯与技术人文。
参考文档
caniuse.com
caniuse.com/ciu/index
另外，MDN 文档中术语表（developer.mozilla.org/en-US/docs/…）和Web APIs 合集（developer.mozilla.org/en-US/docs/…）也是一个寻找写作素材的好去处。
固定素材
又比如最近 Vite4.0 发布了，你要是抢占先机，搞一篇原创文章出来，保证转发量极大。如果你已经晚了，没关系，这个世界上优秀的开源项目何其多，最热门的赶不上，你就发布次热门的。
订阅周刊
- 奇舞周刊
- 阿里妈妈前端快爆
工作实践
这个项目自始至终一帆风顺，没遇到任何困难吗？
这个项目有没有用过以前没用过的技术或者实现方式？
这个项目有没有引用外部的组件或者工具？
这个项目做完之后你一点成长都没有吗？
| 启动错误 | 复杂逻辑 | 正则异常 | 写作平台 | |
|---|---|---|---|---|
| 日常写作 | 如实记录什么错误，怎么解决 | 自己的实现策略 | 哪里写错了 | 非运营平台 |
| 高要求写作 | 进一步分析背后原因，如何再次避免 | 起因、思考、过程、问题、解决及结果完整闭环 | 深入正则分析原因，再举一反三 | 专业社区主账号 |
若问题的出现是因为操作失误或者不了解导致的，或者自己没精力深入挖掘，则适合快速记录，记住，这类文章一定要发布在像是 CSDN、简书这些无心运营，同时可以吃搜索引擎流量的非主力账号上。
若解决的问题确实体现了自己的能力，则这种自我展示的机会决不能放过，大大方方地写下来，放在自己的主力专栏中，例如，我是如何解决XXX问题的？文章的措辞和排版可以多上点心，然后想办法让你的领导和同事在不经意间看到。
需要及时调整
- 抓紧时间拓展自己的知识广度，增加专业积累，很多时候没有创新和变化是因为并不知道同样的东西还有更多更好的实现方式。
- 适当勇敢一点，一点一点地尝试自己没用过的东西，举个很简单的例子，循环可以使用原始的 for 语句，也可以使用 forEach 之类的方法，递归可以通过函数实现，也可以使用 while 语句模拟等。只有尝试不一样的东西才能积累不一样的经验，才能更快速地成长。
也可以是知道了如何更好地沟通和交流，也可以是对产品设计和项目管理的理解更深刻了。
对内输出一定是重点，对外输出是副产物，切不可弄错了主次。
内容为王
合适的标题应该和文章内容、账号品牌和形象以及访问来源相一致。
连贯性
文字层面
文字层面的连贯性主要通过关联词保证，分为八大类，包括：并列、承接、递进、选择、转折、因果、假设和条件。
如“虽然…但是…”就属于转折、“因为…所以…”就属于因果，这个非本小节重点，也比较基础，不展开，大家若有兴趣可自行去了解。
框架层面
框架层面的连贯，一种是通过结构设计实现，另外一种就是使用承上启下的语句强制连贯。
比方说介绍某个浏览器新支持的 JS 属性，如果走时间线策略，那么可以这样设计：
我今天逛掘金
偶然看到了个JS属性
居然没见过
成功地引起了我的注意
于是上去试探了下
呵，没想到这个属性还是个磨人的小妖精
故纵欲擒吗？那我就陪你玩到底
没想到你是这样的属性
该死，我好像爱上这个JS属性了
是不是这么一设计，原本可能很枯燥的 API 特性介绍就变得更耐读了呢？因为更连贯了。
最好的强制中断……很多人应该都使用过，就是“分隔线”！
突出性
脉络清晰
如果文章篇幅较长，内容较多，则标题可以多级嵌套，也就是分二级标题、三级标题，让文章结构更加清晰。
重点突出
操作也很简单：
- 要点标题需体现；
- 亮点位置可靠前；
- 重点篇幅不设限。
如果你想突出技术，则可以这么架构：
标题：我遇到的 JS 属性...
这个JS属性可是个磨人的小妖精
欲情故纵，还会玩火
成功激怒了我
深入交流后发现竟然这般甜美
首先她……
然后她……
再者她……
最后她……
万幸，今天逛了掘金
如果你想突出故事，则可以：
标题：我今天遇到个很棒的事情
今天逛掘金
竟然找到了让我心动的JS属性
怎么回事呢？
我本来……
没想到拒绝我
很好，你已经成功地引起我的注意了
我就继续试探
……
我就说过，你早晚都会是我的
如果你想突出你自己，则可以：
标题：看我如何搞定...
这种事情也就我能做到
这个JS属性是个磨人的小妖精
要想拿下可不容易
我就想着……
于是决定……
结果却挑战我的底线
不能放弃，再次……
这下终于……
看，多么甜美！
学我，你也可以！
具体写作套路
技术科普
技术科普是人人都可以创作的一种文章类型，这类文章适合新人阅读，受众广泛。
这类文章结构可以如下图这般搭建：
原理剖析
受众不一定广泛，但是对于自身的学习却很有帮助。
功能实现
这就要求我们在文章中一定要放代码，最后配上演示页面，然后为了吸引用户继续阅读，通常会把实现好的效果放在最前面，即上面提到的亮点前置。
使用教程
问题解决
问题解决的过程是写给公司内部的人（尤其是领导）看的，或者说写作的目的是炫一把自己解决问题的能力，则自己的思考过程一定要重点阐述。
帮助外面遇到同样问题的人，那就可以多讲讲问题产生的原因，以及如何解决即可，别人对你的思考过程并不在意。
项目总结
项目总结一定是对内的
项目总结的目的本质上就是一种职场邀功炫技手段，而不是技术传道。
会议记录
然后各个城市还有不少免费的技术沙龙，各个技术社区也会有一些免费的线上活动，一些知名行业从业者也会不定期直播，因此，只要你有兴趣，都可以作为观众参与其中。
这种文章不需要技术含量，但是访问量相当的高，因为人都是懒惰的，总希望以最低的成本收获最多的东西。
工具测评
某某框架初体验、A 框架和B 框架我该使用哪个？
还需要一些证明，这些证明就可以通过展示使用过程和最终效果来完成。
技术人文
软技能分享、心理困惑答疑、职业发展指导、行业发展看法等都属于技术人文的写作范畴
职场故事
主体内容
作者角度
团队
比方说你想使用团队账号宣传自研的 UI 框架，哪怕里面代码 100% 都是你写的，你也不能以“我”的口吻进行讲述，更不能进行个人的展示，一定要所有的功劳归结为团队。
同时文章的框架结构需要保守，就正常的文章结构即可，语言也要平实，用实力说话，而非形式，因为中性与稳重的团队形象是最安全，也是最受益的。
个人
但如果你是个人账号宣传，那么理论上，你文章的写作结构是无限自由的，没有所谓的框架，你可以怎么舒服怎么来，哪怕文章开头先来一段废话，吐槽吐槽最近发生的事情，也没问题，在文章中吹嘘老子天下第一，也没问题，只要做好被人喷的心理准备就好。
阅读对象
如果是公司内部平台发文，给同事看的，也希望领导可以看到，那你的内容结构可以围绕如实展现自己的能力和产出展开，遵循不包装，不夸张，不过谦的三不原则，展示最真实的情况。内容上多展示数据和成果，少介绍具体技术细节。
但是，如果是对外发文，则需要包装成这是团队的功劳，都是因为领导的支持，我才能放心去做这样一件事情，然后多讲讲技术实现。
如何制作配图及其相关素材
figma.com/jam
版权问题
pixabay
如果你是商业写作，一定要避免使用。
还有 emoji 图片（非 emoji 字符）也是有版权的，不要随便使用。
录屏工具推荐
screenToGif
在线演示
- 如果是偏视觉、偏交互效果的在线演示，推荐使用 codepen.io/ 这个平台。
- 如果是 JS 代码运行，可以试试jsbin.com/这个站点，优点是即开即用，非常爽气，缺点是好久没更新了，对于新特性的识别有问题，适合纯 Web 演示。
- 如果运行代码依赖于框架或环境，可以试试 codesandbox.io 这个平台，不仅支持纯 JavaScript 的运行，还可以模拟在 Vue、React/Preact、Svelte 等框架，或者在 Node.js 等环境下的运行。
写作角度
- 以数量为切入角度：我一共知道 12 种数组遍历方法，你知道几个？
- 以对比为切入角度：for/for...in 和 for...of 有什么区别？
- 以性能为切入角度：常见 JS 数组遍历方法速度测试
- 以使用场景为切入角度：日常开发，我该使用哪个数组遍历方法？
- 以技术 Tips 为切入角度：forEach 不支持 break？试试使用 some/every 方法进行数组遍历
抒发个人的情绪，表达个人的见解。
白嫖党更关注信息，想法和见解只会影响他粘贴代码的速度，而学习者就希望内容有理有据，通俗易懂
- 如果我是小白，这些术语懂吗？
- 如果我是读者，好理解吗？
- 是不是用个耳熟能详的东西类比下？
- 是不是代码要简化下，加上注释？
- 是不是这里应该放个图？
- 是不是这里应该加个演示？
防盗
版权声明
在文章的头部和尾部放上版权声明还原本地址，很多盗版网站都是直接抓取内容的，会把版权声明信息一起带过去，此时，可以带来一定的访问回流。
图片水印
文章中的配图可以打上独家水印，这个无需每一张图片都打，选几张就足够了。
内容植入
经过我多年的实践，还是内容植入的防盗效果最好。
我们写技术文章，一定会有代码演示，或者截图示意。
此时，图片就可以偶尔使用自己账号头像示意
一些效果演示，就使用自己账号名称：
以及，写作的时候多多引用自己写作的其他技术文章，比方说：
关于这个知识点，可以参考我之前的这篇文章：“XXX……”
文章上带链接，尽可能多地增加原站的回源入口。
软安利
可以在技术写作中，插入对自己作品宣传或安利的内容，这样，就算文章被盗，也会变相地对你的作品进行了宣传。
一定是要软安利，而不是硬推广，否则会认为是广告，会让读者心生反感，区别在于目的不同。
传播
针对不同的平台的传播规律，我们最好需要对文章进行适当的编辑，使其更利于传播。
无论是哪个平台发布作品，都不要在周末和节假日发布推广，因为周末大家的心思都不在学习上，发布的文章没什么人看的。
推荐在上午 9 点之前发布，最晚不超过 10 点，因为早高峰上班是普遍学习热情最高的时候。
另外，工作日的午饭和晚饭时间也有一定的访问量，如果你想错峰发布，可以选择这两个时间点，一般的写作平台都有定时发布功能的，你可以提前设定好发布时间，然后安心上班即可。
如何坚持下去？
- 多多奖励自己
- 学会任务分解
- 敢于放纵自己
- 锻炼延迟满足的能力
- 从他人那里汲取能量
时间分配问题
上下班的通勤时间就可以用金钱购买，很多年轻人租房子住，为了省房租，住得离公司比较远，上下班通勤加起来甚至快2个小时。在我看来，巨亏的买卖，说愚蠢也不为过。
节约时间
不玩游戏不看连续剧；
不社交；
不线下购物。购物不聊天不砍价直接买，买到不合适从不退货，将就或再买一个；
不打扮；
住公司附近；
不自己做饭做菜，外面吃；
不自己洗衣服，洗衣店；
大小号使用离门最近的坑位；
上大号必带笔看书；
大瓶装水，可以减少去饮水机次数；
决不排队买东西；