#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 ,版權歸作者所有,未經許可,不得轉載
你可能還喜歡