(转) 程序员的写作课

前言: 作为程序员的你，如果还在为撰写技术博文而苦恼的话，那么这篇文章很有可能帮助到你哦，Let's go!

俗话说得好，选准赛道在奔跑，只有目标明确了，才不会让你迷失前进的方向。

明确写作目的

• 科普宣传

• 推广技术

• 输出观点

• 展示成功

科普宣传

• 目标（T）：人群相对水平低，有意向了解某一技术的从业者

• 要求（A）：

• 生动：

• 科普文所讲技术往往并非原创，其核心价值主要是提供一些比原生文档更容易懂的展现形式

• 生动不局限于语言生动，更有具体案例，交互性操作更能提升生动性

• 详实：

• 科普文内容可以不全面但是要准确

• 可以提供参考链接来提升准确性和全面性

• 典型场景： 博文

• 科普文案例

• React Hooks 入门教程 - 阮一峰
  

• Introducing Hooks - React.org
  

推广技术

• 目标（T）：技术潜在用户，即下游

• 要求（A）：

• 避免过多的描述细节，这并非用户所关注的重点

• 站在使用者的角度精心设计案例，要让用户惊艳的感觉

• 除了以详细的案例讲解技术的使用，还可以配合数据和事实，论证“我们的产品非常好用”

• 必须配合进一步了解技术所需要的文档链接，不要把文章写成了文档

• 典型案例：

• 揭秘:让阿里前端提效50%是如何计算的
  

输出观点

• 目标（T）：错误观点的受害者，“对方辩友”

• 要求（A）：

• “观点明确”：要有核心观点，立论还是驳论（就是要帮谁）

• “弹药充足”：事实论据、理论论据、代码案例

• “保持优雅”：避免人身攻击，要聚焦问题本身，语言风格可以幽默、犀利强硬，但要友善。

• 典型案例：

• 吐槽一下TC39里的某些人，顺带谈 semicolon-less 风格的危险境地
  

展示成果

• 目标（T）：领导、群众

• 要求（A）：

• 展示成果也是议论文，表达“我的成果很有价值”

• 常见误区：“我做了这个，你来打分吧”

• 摆事实、讲道理

• 重点和难点

• 成果和数据

• 别人评价

• 典型案例：

• 双十一敲钟项目总结
  

整理写作思路

• S - Situation

• 情况；可以讲技术历史、最近的新闻、读者熟悉的技术，拉近读者的距离

• T - Task

• 主要任务，目标；开篇快速提出文章中心思想，过滤不需要的读者

• A - Action

• 动作、行动；实习分享的类容，完成目标需要的工作

• R - Result

• 结果、结论；一些数据或者评价

掌握写作抓手

• 在写这篇文章的时候我面临什么样的场景？我为什么要写这篇文章？通过这篇文章你呢获得什么？

• 我想解决的问题是什么？

• 我如何解决这个问题？

• 我编写文章时引用的资料、我推荐的阅读延伸资料、你进一步的行动指南、广告

我如何解决这个问题？--技巧

• 逻辑关系

• 顺序关系

• 分类关系

• 组合关系

• 维度关系

一个实际的案例： ToyBrowser

作为一个前端，浏览器是咱们每天都要接触的好伙伴，但一旦涉及到浏览器工作原理，很多前端同学就听不懂了，什么“回流”啦，“CSS 优先级”啦，很多文章都在讲，但是系统的讲解却是不多。

今天，砸门就给大家讲讲浏览器的基本实现原理。。。

一个浏览器从用户输入 url，到最后绘制出来页面被我们看到，一般分为 5 个步骤：

1. HTTP 请求

2. HTML 解析

3. CSS 计算

4. 排版

5. 渲染

...

好了，到这里，咱们的浏览器就完成了从 url 到绘制页面的整个过程

下面请欣赏我的牛刀小试1 分钟带你入门 React Context

参考引用：

• winter 前端训练营-《成员的写作课》