每每与身边的开发小伙伴聊到“写作”这一话题，大家纷纷表示真·从小头疼到大。

学生时代每周一篇习作好不容易熬出头，谁能想到工作后居然还有写文章的 KPI 指标。

有时心血来潮想写点东西记录一下，面对新开的空白文档又不知道该写些什么。

在与多个开发小伙伴对话后，我发现大家的痛点集中在以下四点：

• 没有灵感，苦于如何下笔
  
• 思路不清，想写点技术干货，奈何最后成了产品介绍
  
• 缺乏逻辑，主次不明，面面俱到，写到后面内容杂乱堆积、自己都看不下去
  
• 逃避心理，怕自己写的内容被他人挑战"不准确”或“不专业”
  

不得不承认，写作确实需要持续投入大量的时间与精力锻炼笔力，技术写作更甚，只有深刻理解才能用大道质朴的文字，深入简出地阐述技术细节和实现的来龙去脉。在快节奏的时代背景下，对于开发同学而言，投入这么多时间精力在技术写作中似乎“疗效缓慢”，新技术、新框架即学即用，更具有吸引力。

那么为什么仍然建议开发同学进行技术写作呢？

• 长期坚持写作可以对开发者职业生涯有正向增益，甚至还有机会帮助技术人在科技领域脱颖而出；
  
• 将自己理解的技术内容记录、整合并讲述给他人是一个“二次学习”的过程，经过该过程的打磨，对知识的掌握和理解也会得到进一步的提升；
  
• 在技术内容被分享、传递的旅途中，不仅能收获帮助他人的喜悦，还能结交很多志同道合的伙伴，这种被认同、被需要的喜悦，是驱动自我不断学习成长的不竭动力之源；
  
• ……
  

实践出真知，今天想和大家分享几个在工作中总结出来的技术写作小 Tips，希望可以帮助大家快速上手～如果大家有更好的建议，也欢迎留言一起交流～

 Tip 1 克服心理障碍，一笔破万虚

万事开头难。

写作的提升本身就是一个漫长且持续的过程，不要让“完美主义”成为下笔的负担。各种各样的担忧是无穷无尽的，总是停留在心理建设阶段也无益于写作和进步。不妨执起一笔，先把自己想表达的内容写出来，让手中的笔破除所有的虚妄，纸上的文字会给你力量。

同时，任何一篇好的文章都需要经历千锤百炼的过程，方能百炼成钢。仔细想想，任何人、事，不皆如此嘛？所以对于写作新人而言，突破种种拖延、懒惰的借口，顺利完成初稿就是一次可喜的胜利！

 Tip 2 抓住稍纵即逝的灵感

灵感，也叫灵感思维，指文艺、科技活动中瞬间产生的富有创造性的突发思维状态。

有了执笔挥洒的勇气，下一步我们需要的往往是抓住那稍纵即逝的灵感，知道自己想写的内容。

灵感的产生往往是宝贵且脆弱的，一声咳嗽、一个蹙眉可能就会令其无疾而终。一旦错失最佳记录时机，再想回溯一下一闪而过的灵感时，却会发现怎么也想不起来了。

那么何不在一开始就将灵感快速记录下来？

“诗鬼”李贺每次外出时都让书童背一个袋子，只要灵感浮现，便马上记录下来装进袋子里，回到家后再重新整理成诗，在他短暂的二十六载人生中，留下的诗作多达二百余首，其自身也成为了唐代浪漫主义诗人的杰出代表。

现代的信息记录方式远比古人方便快捷的多，我们身边的手机、电脑等都可以成为灵感的即时记录工具。强烈建议大家建立一个属于自己的“灵感库”，在碎片时间里记录的只言片语都可以在闲暇时整理收录其中，经过不断积累，再回看时你会惊叹于原来自己还有这么多有趣的想法！

浅浅延伸一点：关于日常如何产生更多灵感这件事，我个人的建议是：多阅读。

读书破万卷，下笔如有神。

阅读是让大脑不断思考的过程，大脑就像肌肉，如果你不用它，那它就很懒，一动不想动，开发利用的区域就很小。所以遇到需要思考的事情，有人会感觉脑袋空空如也、遇到事情一片混沌、思考链路很短、逻辑不清晰；但是如果你经常锻炼它，不断思考，那生活和阅读中的一个个触点，都有极大概率触发你的联想和思考。只要不断增进阅读，“才思泉涌”和“醍醐灌顶”将触手可及。那一抹来自心底的悸动，绝对妙不可言~

 Tip 3  不要让任何一个“BUG”轻松划过

作为程序员，大家心中都有个简单质朴的愿望：“愿天下无 BUG！”

现实很骨感，各种 BUG 在工作中无可避免。我们首先要保持乐观的心态去面对，一个问题的产生不一定是坏事，它能反映出我们对技术的思考仍有不完善的部分，对于代码的掌控还存在漏洞。

正相反，如果我们利用好这些bug，它们反而会反哺我们的专业知识和能力。我们可以将其出现到解决的过程做一深度复盘，给自己做经验的积累，避免下次栽倒在同样的坑里，只要你一直在奔跑，前进的路就会一直延续。再者，对问题的总结和提炼如果可以继续抽象，成为通用解决方案，那么还可以使自己所在的团队，甚至是更多人受益。

 Tip 4  下笔前四问：Why、Who、What、How

在一切就绪准备写文章前～不妨先问自己四个小问题，帮助自己快速定位发力方向，往往能达到事半功倍的效果：

一问：为什么要写这篇文章（Why）

在下笔前首先理清：这篇文章的目的和价值到底是什么？

和大家分享一段亲身经历：

几个月前，身边的几个朋友在茶余饭后都喜欢聊聊“管理”方面的话题，有的观点给我带来了全新的思考，于是我迫不及待的将这些绝妙的点子逐一记录，花费一个周末的时间形成了一篇以“聊聊管理”为主题的经验分享文章。

当我满心欢喜的将文章拿给身边朋友看，希望大家帮我提提建议时，发现内容根本经不起推敲，因为自己本身缺乏管理经验，无法用切身事实论据来支撑文章中“听来的观点”，写的时候其实也充满痛苦，因为想要把别人的经验之谈转化为向外输出的内容并不是一朝一夕就能办到的。

后来我改变了思路，将文章的形式改为一篇小记，仅仅是对大家精彩的观点做一记录，并附加了一些自己的思考。这下写的过程很轻松、很愉悦，文章看起来也不再有“小孩试穿大人衣服”的违和感。

大家在下笔前不妨先给文章“定个调”，是对当下思考的随笔小记？还是对专业技术领域的分享/布道？抑或是高度抽象出的解决方案？不同文章形式分别对应不同的行文思路和框架结构，提前做好判断避免给自己“挖坑”。

二问：这篇文章想写给谁看（Who）

明确内容受众，针对不同群体对内容的技术深度、表达方式进行调整。只有明确受众，真正从受众角度出发去撰写，文章才有的放矢，达到期望的效果。

以下列举几个不同纬度供大家参考：

• 自己 or 他人
  
• 没有技术背景的人 or 技术从业人员
  
• 初级开发者 or 高级开发者
  
• toB or toC
  
• ……
  

三问：文章的重点内容是什么（What）

很多技术同学在写文章时经常会遇到这样的场景：一个技术栈内容对应很多分枝，每个都想讲清楚，最后文章越写越长，偏离主题不说，还迟迟无法收尾。

这里建议下笔前明确文章想要表达的重点内容和其他内容，解耦知识模块，删除赘余部分。这样可以帮助文章内容做到丰富详实且不冗长，也不至于在文章撰写的过程中“迷失方向”。

四问：如何保证文章逻辑的流畅与结构的完整性（How）

对于大部分读者而言，一篇好文章的阅读过程应该是流畅且结构通顺的。

对于程序员而言，想把一个复杂的技术问题讲清楚，对其文字表达能力而言也是不小的挑战。

如果一篇文章叙述能够行云流水一气呵成，那是再好不过了。但是更多时候程序员在进行技术写作时还需要查阅相关资料、引用知识点链接等，时不时弹出的信息和需求，很容易导致注意力被分散，再想续上文章思路还需要额外多花些功夫。

这里建议，刚开始进行技术写作的大家不妨试试结构化叙事方法，即：先把想表达的内容框架搭好，再根据框架填充内容。

这样即使在碎片时间里，也能快速对文章未完成的内容进行补充，不用每次执笔都从头再去捋一遍思路。

如果大家对结构化思维感兴趣，这里也推荐大家深入阅读《金字塔原理》这本书，帮助我们在写作、表达时构建清晰的思维结构。

《金字塔原理》介绍了一种能清晰地展现思路的高效方法，是训练思考、使表达呈现逻辑性的实用宝典。金字塔原理能将零散的观点有序组织起来，化繁为简，适合所有需要精进思考、分析、表达能力的读者。

今天想要和大家分享的技术写作小 Tips 到这里就结束啦，写作是一个长期的过程，希望大家都能享受写作带来的快乐～

参考链接：

1. 百度百科：灵感

https://baike.baidu.com/item/%E7%81%B5%E6%84%9F/18583?fr=aladdin

2. 《金字塔原理》

https://book.douban.com/subject/33391219/

更多内容欢迎关注【绯绡】公众号

一起分享 共同进步