【实战】分享一个花了 499 学到的写作方法:问题 + 回答

简介: 我发现这个方法跟我有一些文章的方法很像,但是我并没有这样总结出来,而是在写的时候自然而然就这么去设计了。

大家好,我是桃翁,一个不止前端的前端工程师。


前言


前几天在一个写作课里学习到一个写作技巧:文章 = 问题 + 答案。


大概就是说当你看到一个话题,想写成文章的时候,可以想一想你针对这个话题会有哪些问题。然后挨个回答一下这个问题,把回答组合一下,就成为一篇文章了


我发现这个方法跟我有一些文章的方法很像,但是我并没有这样总结出来,而是在写的时候自然而然就这么去设计了。


以这篇用 husky 和 lint-staged 构建代码检查工作流 文章举个例,做一个实战教学,建议看下面的内容的时候先阅读一下这篇文章。


实战


一、提问题


我要介绍的主题是:构建代码检查工作流


针对这个主题,我想到了几个问题:


  1. 什么是代码检查?


  1. 什么情况下需要用到代码检查?


  1. 怎么做代码检查?


  1. 怎么把代码检查做成工作流?


注意:每个人想到的问题不一样,所以写的思路可能也不太一样。

如果想不到什么问题,我这里给到的建议可以提 what、when、why、how 这样的问题,这也是一种写作方法,后面再讲。


根据以上的思路就可以把大纲列出来。


二、列大纲


其实一般可以直接把这些问题当做大纲。


但是我这篇文章后面又考虑到怎么做代码检查东西比较多,只有在知道了最基础的代码检查方法之后,才可能推出要用 husky 和 lint-staged 这样的工具。


所以我最终还是以陈述的方式为大纲,一步一步的引导,最终把把代码检查做成工作流。

所以最终这篇文章的目录大概是这样的。


640 (7).png


前言里面回答了什么是代码检查什么情况下需要用到代码检查


在最简单的方法这个大纲里就是怎么做代码检查


最后的三个都是讲怎么把代码检查做成工作流。


三、回答问题


大纲做好了,就开始填内容了。


前言就没什么好说的了,主要是介绍背景,然后引出我们怎么做代码检查。


接下来就写了最简单的方法来做代码检查,再提出了两个问题


640 (8).png


其实这两个问题就是来解决工作流的问题。


下面的两个段落就是来解决这两个问题,看到没有,这又是问题 + 回答的模式,不仅大话题可以引发问题,还可以问题里套问题。


标题:通过 scripts 来解决如果检测工具多,需要多次处理,解决问题 1.


标题:通过 husky(哈士奇)来解决容易遗忘的问题,解决问题 2.


所以整篇文章都是以问题驱动,一步一步引导读者把小问题解决了,最终串起来就把大问题解决了。


总结


总结一下,这种问题 + 回答的写作方式有什么好处:


  1. **段落之间具有连贯性。**每个标题之前都是承上启下,都是来解决上面一个标题的问题,然后引出下面一个问题。


  1. 读者读起来很流畅,会产生恍然大悟的感觉。


最后再复盘一下这篇用 husky 和 lint-staged 构建代码检查工作流 我觉得不好的地方:


  1. 标题不够小白,导致受众不够多导致打开率低。


  1. 在前言里背景介绍得不够细致,如果以前没做过这方面的,可能体感不强。
目录
打赏
0
0
0
0
8
分享
相关文章
【阅读】一周翻过《构建之法》,笔记整理
🚩 前言 我的阅读方式 我拿到这本书挺久了,之前已经零散地看过一部分,最近一周集中地花了一些时间,将整本书看过了一遍。看得比较粗略,正如“好读书,不求甚解”(我甚至没有去看书中提到的那些参考资料)。
83 0
我花了半个月,整理出了这篇Linux内核开发学习指南(学习路线+知识点梳理)
我花了半个月,整理出了这篇Linux内核开发学习指南(学习路线+知识点梳理)
面试问到IOC我该如何回答呢?
相信在面试中,只要问到Spring,基本都会抛出一个问题,说说你对Spring IOC理解吧?虽然在日常的开发经常会使用到,但是要回答起来,并不简单。大脑经过简单的头脑风暴后,蹦出了控制反转、依赖注入这样的词语。显然这些并不是面试官想听的。
为什么别人不想回答你提的问题?
为什么别人不想回答你提的问题?
154 0
测试领域专业术语整理-持续更新
测试领域专业术语整理-持续更新
403 0
前端面试篇,应届生面试时被问项目经验不用慌,按这个步骤回答成功率高达95%
前端面试篇,应届生面试时被问项目经验不用慌,按这个步骤回答成功率高达95%
面试遇到不会回答的问题,如何力挽狂澜 ?
今天给大家讲讲面试过程当中最长遇到的窘境,也是最能体现一个候选人临场应变能力的地方,那就是当我们在面试的过程当中,遇到的问题回答不上来的时候,该怎么办。
208 0
AI助理

你好,我是AI助理

可以解答问题、推荐解决方案等