1. 写作如写代码一般重要

从行为上看写作和写代码都是在 Typing (打字)，只不过，写作面向的是人，写代码面向的是机器。

写代码是为了能控制机器的状态，让其按照预设的指令转换；而写作是为了传达知识，让其他人能够按照预设的逻辑理解。

因此，写代码和写作其实是两种很贴近的模式。同时，对于工程师来说，写作如写代码一般重要。

对于一个学习者，听说读写是绕不开的基本技能。通过听读，输入知识；通过说写，输出知识。

教学相长，在输出知识的同时，教学者也会进一步得到提高。写作就是其中非常重要的一个环节。

写作可以提升对知识的理解深度、自我表达能力、个人影响力，让自己的思路更加清晰，对问题的理解更加透彻。下面我们一起来看看，如何像写代码一样写技术文章。

2. 选好主题 - 找准需求

选好主题就是要找准目标人群，选择自己最擅长、最感兴趣的方向进行写作。这里有一些方向，可供参考:

• 前沿趋势

在科技媒体头版、GitHub Trending、Google Trends、行业主流公众号、CNCF 大会等，都可以找到前沿趋势的踪迹。如果对行业有所观察，那么前沿趋势会是一个不错的选择。比如，边缘计算、Serverless 等。

• 产品介绍

选择有前景的产品，将产品带到合适的人面前，是一件很棒的事。因为，很多人没有使用一个产品，可能只是因为不知道有这个产品。作为一个布道者，能够给大家带来巨大的价值。

• 技术优化

在工作的过程中，会碰到一些技术瓶颈，通过一步一步地优化，我们最终解决了问题。记录解决问题的过程，思考产生问题的原因，挖掘潜在的风险，对业务来说非常重要。

• 学习笔记

不要随意地复制粘贴知识片段，然后保存作为学习笔记，那并不是你掌握的知识。像写文档一样，认真写好学习笔记，才能与已有的知识体系融为一体。

• 竞品比较

比较市场上不同产品之间的差异，给出测评结果，将会非常考验人对领域知识深度和宽度的掌握。但是，竞品比较是人们最愿意阅读和议论的方向。

• 场景应用

针对某一个产品，在不同场景下的不同使用方式，反复多次实践。这是一个产出率非常高的选题方向。

• 思考心得

对工作、对行业、对人生，都需要定期总结。时间只能给我们宽度，自我审视才能给我们深度。

3. 列出提纲 - 设计架构

3.1 总结分论式

《研发如练兵，运营如用兵》

1. 思想驱动行为
2. 研发如练兵
3. 运营如用兵

首先给出一个总结性的描述，然后对相关的模块分别进行详细介绍，各个击破。

3.2 实验报告式

《Kubernetes 动态创建 Jenkins Agent 压力测试》

1. 集群配置
2. Jenkins 配置
3. 测试策略
4. 测试结果
5. 测试总结和建议

首先给出前提配置，然后描述执行过程，得到执行结果，最后进行总结和评论。忠实的记录者，不带任何感情，犹如一篇实验报告。

3.3 并行罗列式

《你不知道的 Docker 使用技巧》

1. 分阶段构建
2. 利用缓存构建
3. 使用 S2I 打包应用
4. .dockerignore 文件
5. 将容器保存为镜像

围绕一个主题，使用排比的手法，不断地罗列举证，以此强调主题。

3.4 故事引导式

《运营不再是拍脑袋的事》

1. 运营不再是拍脑袋的事
2. 精细化运营了解用户行为
3. 短链接的妙用
4. 下载链接也能做文章

首先通过一个新颖的描述，抓住眼球，然后引出主题，给出核心观点，建立若干支撑论点。

3.5 对比论述式

《使用 S2I 构建云原生应用》

1. S2I 能解决什么问题
2. S2I 的特点
3. S2I 与 buildpack 区别
4. 尝试使用 S2I

通过比较的手法，与同类主题进行差异化对比，借助同类主题，快速进入读者的心智。

3.6 优化递进式

《Kubernetes 中如何获取客户端真实 IP》

1. 创建一个后端服务
2. 直接通过 NortPort 访问获取真实 IP
3. 通过 LB -> Service 访问获取真实 IP
4. 通过 LB -> Ingress -> Service 访问获取真实 IP
5. 总结

围绕一个问题，不要直接给出最佳的方案，要不断地优化方案，给出优化的路线，展现逻辑的演变过程。一波未平一波又起，跌宕起伏，在湮灭与希望中辗转，岂不妙哉。

3.7 采访问答

Q: DevOps 是什么
A: DevOps 是一种文化
Q: 为什么需要这种文化
A: …

一问一答，像柏拉图、孔子一样，采用对话的方式阐述其思想。以第三方的角度，以问答的形式，表达出观点。

4. 填充内容 - 编码实现

建议阅读阮一峰的中文技术文档的写作规范 。

简单列举一下，我比较注意的几个点:

• 断句。无论是否适合断句，我都会适当加标点，避免一句话太长没有停顿。
• 区分地的。接动词用 “地”，接名词用 “的” 。这也是我检验文档描述用词，是否准确的一个小技巧。
• 英文、数字前后加空格。看起来更美观。
• 避免歧义的描述。即使有 99.99% 的可能，也不能描述成一定。
• 尽量使用客观描述。少使用，我认为、我觉得，这样的关键字。

5. 矩阵传播 - 运营上线

有了文章内容之后，我们完成了从无形到有形的转换，有了第一个传播媒介。根据文档，还可以继续扩充传播媒介，转换为系列文章、书籍、短视频、长视频、直播、分享、课程等。

然后就是如何抵达用户。下面是一些科技用户常驻地：

• 搜索引擎推荐，SEO
• 百家号、头条号、博客园、CSDN、腾讯云社区，简书、InfoQ、TWT、Reddit、Medium、Dzone
• 朋友圈、微信群、QQ 群、微博
• 抖音、快手、视频号、B 站、Youtube
• V2EX、知乎、Linkedin、Twitter、Facebook

6. 持续研发运营

一个好的系统是不断迭代优化，不断经营用户出来的。不用在乎起点，也不用在乎速度，只要选好了方向，干下去就能收获美好，因为坚持本身就是一件很值得回忆的事情。

日拱一卒无有尽，功不唐捐终入海。再小的进步，再小的努力，随着时间的推移，也会变得非常有意义。

人们常常会放大短期的影响，而忽略长期的影响。愿你我都能做长期的守护者，持续地投入热情，持续地经营琢磨，让一件件小小的事情变得美妙。

没错，我说的是写作。