#discussKISS?:保持简单&*简短* – 我的技术写作校长

我是一个真正的信徒,不是没有时间。所以我努力保持我的帖子简单和短(阅读时间不到3分钟)。这篇文章分享了我对KISS写作校长的态度。

分解,然后分解

每当我发现自己写的东西超过3分钟时,我会回头看看是否可以分解成多个帖子。

例如,我曾经遇到过“为您的网站改进SEO的3种简单方法”的帖子。但在起草过程中,我认为帖子中提到的3种方式并不紧密相关,所以我决定改为3个帖子,每个只解释一种方法。

通过这种方式,我的每个帖子都更加专注,标题更清晰,并且可以帮助读者在很短的时间内获得非常具体的信息。

为什么>如何

我更喜欢谈论为什么如何。为什么?因为在线已经有太多的方法文章:如何构建应用程序,如何使用AWS服务等等。但是,如果读者理解技术和概念,这些只是有用的。在我看来,有很多好文章解释了围绕技术的概念和背景。我曾经是一名科技初学者,我理解当我在不知道大局的情况下盲目地遵循教程时我感到多么失落。

由于我只有3分钟的时间来解释一些事情,我会专注于讲述大局:为什么技术存在,它在哪里发光(或不在哪里),如何与替代品相比,并将“如何”部分留给读者自己(或链接)。

例如,有数百篇在线文章谈论如何设置Babel和Webpack,但在阅读了很多这些文章之后,我仍然不明白为什么我需要其中一个或两个。所以我写了自己的:

techbos图像

WTF是Babel和Webpack??在2分钟内解释。

TechBos?·9月8日·3分钟阅读

#beginners #webdev #webpack #babel 使用简单,非科技的单词

如果你还没有,请阅读亚马逊所说的与让我们更容易理解的内容:

lewismenelaws图像

什么是AWS?初学者指南。

Lewis Menelaws·5月28日·8分钟阅读

#aws #javascript #生产率 #beginners

感谢AWS让他们更难理解他们的产品(也就是隐藏他们的收银员)

即使针对有经验的受众,技术帖子也不应该像论文一样。另一方面,有时即使是经验丰富的开发人员也不理解那些抽象的共鸣技术词汇。就个人而言,当概念用简单的词语解释时,我总是觉得它很有用,并带有现实世界的例子。这使得帖子简单易读。样本帖子:

'x-www-form-urlencoded'或'form-data'??在2分钟内解释。

TechBos?·9月1日·3分钟阅读

#html #javascript #webdev #http 相对

我一直觉得科技没有什么新东西。几乎任何“新的”技术,无论表面上看起来多么花哨,都可以与几年甚至几十年前的一些前辈或替代品相关联。

在解释“新”或“花式”技术时,与读者更熟悉的一些已有技术相关或比较总是有帮助的。这允许读者利用他们已经知道的内容并将新概念链接在其上。它还使我免于从头开始解释概念,这有助于KISS。例如。,

Webhook只是说“事件驱动的服务器到服务器API调用”的一种奇特方式?♀️在1分钟内解释。

TechBos?·9月9日·1分钟阅读

#webdev #webhook #生产率 #http

好的,我将在3分钟的标记处停下来。我喜欢写KISS帖子来帮助人们兴奋并学习技术。请关注我的Twitter @tech_bos,以便您知道我何时发布新帖子

写作是一个非常主观的话题。对于dev.to社区中所有优秀的作家:你遵循什么样的写作原则?请在下面的评测中分享您的专业提示❤️❤️❤️

资讯来源:由0x资讯编译自DEV,原文:https://dev.to/getd/kiss-keep-it-simple-short-my-tech-writing-principal-jjn ,版权归作者所有,未经许可,不得转载
你可能还喜欢