掘力计划二期的关于技术写作的观后感，及常见QA

头图/邓邓鲁迅百草园

4月17日，我们在掘金社区举办了掘力计划：创作者训练营第二期，听完几位老师的分享，作为从业几年小编的我，真的受益匪浅。所以我打算总结下几位老师讲的重点，分享给大家。然后，补充一些常见的疑问。

工业聚分享的是《和工业聚一起聊聊技术与写作》，

主要内容分为八个部分：

第一部分：技术与写作的关系

这部分，工业聚认为，技术与写作并不是割裂开来的，写代码其实就是一种写作。

第二部分，主要分享几种常见的技术写作的种类

比如：代码注释、技术文档、需求文档、工作邮件、错误报告、即时聊天、技术文章等。

第三部分，他分享了为什么要参与技术写作？

我觉得这部分很有意思，对于我们来说，凡事多问一个Why，其实是很有必要的；工业聚的观点是：技术写作是贯通技术实践和技术表达的桥梁；然后通过五个层面来详细证明这个观点（如图1），包括多加学习、多加思考、多加实践、多加写作、多加表达；通过这五个多加，对应的增加了自己的知识储备、提升自己的理解水平、丰富自己的实践能力、丰富自己文本表达、更好的组织自己的口语表达。

图1

听过当天直播的小伙伴，应该会有印象，工业聚的逻辑特别清晰，讲述的条理性也很棒。这五点能力层次模型我对应整理为：学到更多（Learn More）、更多思考（Think More）、Practices More（更多练习）、强化逻辑（Reinforcement logic）、表达自己（Express Yourself）。

第四部分，技术写作定位

他分享的是技术写作的几种定位；分别是技术专家、技术网红/自媒体、技术作家；根据定位去对应的输出相关的技术文章，或是交流技术问题、深入研究专业方向，以及当下技术热点讨论等。

他作为一个高产技术文章的KOL自然会考虑到一些，传播向、科普向、研究向的一些问题；但是作为一个普通的或者大众的技术写作者来说，一般是笔记总结类、分享文章类、吃瓜热点类。对于分享类的文章，你就需要考虑到你的受众，根据受众去合理优化你的文章，这样传播更广。笔记类一般是给自己看的比较多，但是为了避免你很久之后来看自己的笔记看不懂，建议细化下内容，添加下当时是怎么思考的，这样一来不仅其他人看到你的文章会受益，之后你复习的时候，也能事半功倍。

第五部分，文本的质量光谱

主要观点是：高质量的文本——在事实和理性的基础上建构可靠的知识体系。按照我的理解，就是，写文章基于事实来，不能脱离实际；凡事多思考，不盲从。

第六部分，技术写作的误区

这部分diss的文章类型比较多；具体的可以去工业聚发的文章链接去看，很详细。主旨就是，内容为王，不要做文档优化大师，不要流于形式。

第七部分，严肃型技术写作的基本模式

其实就是我们大学毕业论文的格式。
包括：
a.摘要/前言(Abstract/Preface)
b.主题介绍(Introduction)
c.结构概览（Overview）
d.内容主体(Main body)
e.总结/反思(Conclusions/Reflections)
f.致谢(Acknowledgements)
g.参考文献(References)

第八部分，进行了回顾与总结。这里我贴上工业聚在会后发的原文链接，感兴趣的小伙伴可以详细看看。mp.weixin.qq.com/s/0gGr8TD3Y…

袁滚滚分享的是《寻本溯源：中美技术写作历程与经典分析》

这个话题确实眼前一亮，有种外面的世界竟是这样的感觉。她分享的内容主要是三个部分，包括技术写作往事、技术写作的意义与价值、中美技术写作流派与经典分析。

技术写作往事

通过第一部分技术写作往事，我们了解到，其实技术写作是一个古老的职业，大概在公元前 384-322 年就出现了。然后从国外和国内来分别分析，技术写作的发展。包括，国外的 Geoffrey Chaucer《星盘笔记》（1343–1400）、牛顿 1687 年出版《自然哲学的数学原理》；国内的 1956 年夏培肃设计电子计算机运算器和控制器，同时时编写电子计算机原理讲义；以及大家熟悉的《电脑报》《程序员》。
还通过几个大家熟悉的技术写作界的大佬，池老师、阮一峰、（还有一个我不认识，孤陋寡闻了）来给大家树立榜样。图2

图2

技术写作的意义与价值

第二部分，分享了技术写作的意义与价值；这部分重点分享了技术文档、技术文章、技术图书的写作的具体框架以及对应的实用工具；我对应的截图，方便大家快速了解下：

1.技术文档写作流程及工具介绍；写作流程主要有六个阶段，包括准备、调研、画框架、写作、修改、更新等。工具侧主要是ProcessOn（做时序图、流程图、脑图等）、markdown（文本编辑器）、DeepL（翻译助手，我在知乎找到了一篇相关文章，zhuanlan.zhihu.com/p/130333653…