发布于 2026-01-06 1 阅读
0

KISS 😘:保持简洁明了——我的技术写作原则 分解问题,深入探讨原因而非方法 使用简单易懂的非技术词汇 保持客观中立 由 Mux 呈现的 DEV 全球展示挑战赛:推介你的项目!

KISS 😘:保持简洁明了——我的技术写作原则

把它分解开来,再分解开来

为什么 > 如何

使用简单、非技术性的词语

要有亲缘关系

由 Mux 主办的 DEV 全球展示挑战赛:展示你的项目!

我深信“时间就是金钱”,所以我努力让我的文章简洁明了(阅读时间不超过3分钟)。这篇文章分享了我践行KISS写作原则的方法。

把它分解开来,再分解开来

每当我发现自己写的东西超过 3 分钟时,我都会回头看看能不能把它拆分成多篇文章。

例如,我曾经看到一篇题为“提升网站SEO的3个简单方法”的文章选题。但在撰写过程中,我发现文章中提到的3种方法关联性不强,所以我决定改写成3篇文章,每篇文章只解释一种方法。

这样一来,我的每篇文章都显得更加聚焦,标题也更加清晰,能够帮助读者在短时间内获得非常具体的信息。

为什么 > 如何

我更喜欢探讨“为什么”而不是“怎么做”。为什么呢?因为网上已经有太多“怎么做”的文章了:如何开发应用、如何使用AWS服务等等。但这些文章只有在读者理解了技术和概念之后才有用。而我认为,真正能解释技术概念和相关背景的优质文章却少之又少。我曾经也是个技术新手,所以我能体会那种盲目地照搬教程,却对整体情况一无所知时的迷茫。

因为我只有 3 分钟的时间来解释某件事,所以我将专注于讲述大局:这项技术存在的原因、它的优势(或劣势)、它与替代方案的比较,并将“如何做”的部分留给读者自己(或通过链接)。

例如,网上有数百篇文章讲解如何配置 Babel 和 Webpack,但我读了很多之后仍然不明白为什么需要其中一个或两个。所以我自己写了一篇:

使用简单、非技术性的词语

如果你还没看过,请务必阅读这篇精彩文章中的“亚马逊的说法vs.让我们把它解释得更容易理解”部分:

AWS 真厉害,居然让他们的产品更难理解(也就是把收银员藏起来了)!

技术文章不应该写得像论文,即使目标读者是经验丰富的开发者。另一方面,有时即使是经验丰富的开发者也未必能理解那些抽象的技术术语。就我个人而言,我总是觉得用通俗易懂的语言,结合实际案例来解释概念很有帮助。这样文章就简单易读了。以下是一个示例文章:

要有亲缘关系

我总觉得科技领域没有什么真正意义上的“新”东西。几乎任何“新”科技,无论表面上看起来多么炫酷,总能找到一些几年前甚至几十年前的先例或替代方案。

在解释一项“新”或“高科技”技术时,将其与读者更熟悉的现有技术联系起来或进行比较总是很有帮助的。这可以让读者利用他们已有的知识,并将新概念与之联系起来。这也能避免我从头开始解释概念,从而有助于保持简洁易懂。例如:


好了,我就说到3分钟处。我喜欢写简洁明了的文章,帮助大家激发对科技的兴趣,并学习相关知识。请关注我的推特账号 @tech_bos,这样你就能第一时间知道我发布新文章啦!

写作是一个非常主观的话题。dev.to 社区所有优秀的写手们:你们遵循哪些写作原则?请在下方评论区分享你们的写作秘诀❤️❤️❤️

文章来源:https://dev.to/getd/kiss-keep-it-simple-short-my-tech-writing-principal-jjn