【实战】分享一个花了 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. 在前言里背景介绍得不够细致,如果以前没做过这方面的,可能体感不强。
目录
相关文章
|
机器学习/深度学习 人工智能 供应链
如何正确的提问,获得最有效的回答帮助?
如何提高程序员的工作效率? 如何在云计算中实现智能化? 如何使用人工智能技术改善医疗保健行业? 如何保护个人隐私在数字化时代? 如何应对人工智能带来的就业变革? 如何构建高可靠性的云计算系统? 如何使用区块链技术改善供应链管理? 如何实现可持续的数字化转型? 如何使用机器学习技术预测未来趋势? 如何构建安全可靠的物联网系统?
488 1
|
搜索推荐 程序员 Python
为什么新手在编程社区提问经常得不到回答,甚至还会被嘲讽?
学编程难免遇到问题,遇到问题就需要上网求助。然而有过不少同学向我诉苦,说在网上提问没有人回答,有的还收到一些不是很友好的回复。我自己也在经常上的论坛上目睹过类似的帖子。以至于有人说,程序员社区就是对新人不友好,不愿帮助新人,甚至说这是怕别人学会了来抢饭碗。
|
人工智能 搜索推荐 程序员
为什么新手在编程社区提问得不到回答,甚至还会被嘲讽?
说了这么多,你也不要因此而不想提问题。该问的还是得问,要敢于提问和讨论,甚至要上 StackOverflow 等英语网站去问。不然怎么提高自己?不但要问,还要回答,“教”是最好的“学”。当你能向别人解释清楚一个东西时,才是你真的理解了它。既回馈了社区,又提升了自己,何乐而不为?
|
Kubernetes 算法 中间件
简历中的项目到底该如何写?面试中该如何介绍项目?看这篇就足够了
简历中的项目到底该如何写?面试中该如何介绍项目?看这篇就足够了
|
数据采集 Python
为什么别人不想回答你提的问题?
为什么别人不想回答你提的问题?
146 0
|
存储 Linux
疑惑、问题、生疏及解决(持续更新)
疑惑、问题、生疏及解决(持续更新)
161 0
疑惑、问题、生疏及解决(持续更新)
|
SQL 监控 前端开发
标准回答奉上!软件测试面试的这些话术赶紧拿走
软件测试是一个复杂且重要的技术岗位,因此,大多数互联网企业在面试时,都会严谨对待每一个面试者。 而,作为即将去进行面试测试人来说,想要在面试中,沉着稳定地回答好面试官们提出的问题,前期的软件测试面试话术准备就少不了。
376 0
|
前端开发 测试技术
测试领域专业术语整理-持续更新
测试领域专业术语整理-持续更新
360 0
|
弹性计算
阿里云的学习收获
利用老师给的网站进行阿里云的学习,领用到云服务器ECS后,使用云服务器进行一系列的学习。
|
算法 Java 数据库
面试遇到不会回答的问题,如何力挽狂澜 ?
今天给大家讲讲面试过程当中最长遇到的窘境,也是最能体现一个候选人临场应变能力的地方,那就是当我们在面试的过程当中,遇到的问题回答不上来的时候,该怎么办。
195 0