程式設計師的寫作課:一、關於技術寫作的那些錯誤思想
破山中賊易,破心中賊難 —— 王陽明
在正式開始我們的課程內容之前,我們先來聊一聊技術寫作過程中,你會遇到的那些錯誤的思想,讓你對技術寫作有所改觀。
1. 我們搞技術的人寫不來文章,那個是運營(文案)的活
寫作是屬於我們向世界表達看法的工具,它屬於每一個人。你寫一句話也是寫作;你寫一段話也是寫作;當你開始寫的時候,你就已經在寫作了。
不要畏懼寫作,寫作是我們必備的技能,在職場中,我們經常要寫週報、年報,在家裡我們偶爾要給老婆寫一下感言,這個東西我們必需,所以我們必練。
對寫作重視起來,然後開始寫吧!
2. 技術寫作文筆不重要,乾貨才重要
不少程式員在寫作時不甚用心,可以理解,畢竟大家工作那麼忙,總是996,哪來的時間寫作呢,但是, 時間不足不意味著你就可以認為「內容重要,文筆不重要」 。
首先, 文筆也是內容的一部分 ,當你說出內容重要文筆不重要時,你就將文筆與內容割裂開來,在一開始就出現了錯誤。
其次,對於文筆,我們的確不應該以專業作家的要求來要求普通的程式設計師,但是不意味著你可以完全不在意文筆,甚至以文筆好為恥,認為那不是一個正經的「程式設計師」。寫作與每個人都有關,與職業無關, 我們每個人的文筆不可能都做的非常好,但是,我們可以讓自己的文筆在自己所能做到的極限中,達到最好 。
最後,文筆的好壞往往以修飾詞出現的多少,語句之間的起承轉合的流程與否來進行評判,這使得文章中出現了大量的與核心思想本身無關的內容,固然讓文字顯得「水」了一些,但是,卻能讓你的文章的可讀性大大的提高,不再晦澀難懂。
所以,想要寫好文章,首先,別拒絕文筆。
3. 技術文章只要乾貨多,就是好文章
乾貨是我們經常評判一篇文章好壞的標尺,對於乾貨較多的文章,我們會點贊,對於乾貨較少的文章,我們就會唾棄。
但是,在寫文章之前,你需要先考慮你的文章的受眾,再進行乾貨的排布。
面向高階工程師和初級工程師的文章對於乾貨的需求必然是不同的,如果你錯配了需求,乾貨再多,也會被讀者吐槽。
一個比較典型的例子是,當你需要寫給初學者看的時候,乾貨異常豐富的官方文件可能並不是一個好的選擇,太多的乾貨帶來的巨大資訊量會讓初學者在一開始整個通道就被佔滿,無法進行內容的學習,同時,還會在一開始給他巨大的學習壓力。個人寫的教程、視訊教程則相反,抽離出最核心的內容,並對內容進行排布,讓初學者可以很輕鬆的就進行內容的學習。
但是,我們在寫文章時,不能為了更好的可讀性就一味的降低乾貨的量,所以,面對初學者的文章時,你除了儘可能的簡化你所能提供的資訊,還需要平衡乾貨的量,這一部分,我通常是以 參考連結 、 延伸閱讀 的形式來完成的,幫助讀者更好的去學習所學的內容。
4. 吸引眼球的標題不是好標題
標題只是一個工具,真正令人討厭的不是標題,而是標題背後的那個人。
我們每個人都討厭標題黨,但是我們不應該討厭一個好的標題。標題黨的主要行為是「發帖的標題嚴重誇張,帖子內容通常與標題完全無關或聯絡不大」,讓我們有較高的期待和隨之而來的較大的失望。但是從功用的角度來說,他們的標題很好的完成了自己的工作,將人們吸引進來。
在資訊充裕的時代,我們往往會通過資訊流來選擇自己想要看的內容,這個時候我們必然不能通過閱讀每一篇文章來選擇,那樣就不是選擇,而是遍歷了。在這個時候,一個好的標題,能夠幫助你更好的吸引讀者進來看,讓你的內容能夠從眾多的文章中脫穎而出。
我們應該合理的利用好標題吸引讀者進入的功能,來為我們的文章選擇更多可能的讀者。
5. 寫作只是寫就可以了
寫作不單純是寫,寫只是寫作中最後一個環節。
寫作的完整流程應當是「輸入」- 「處理」 - 「輸出」,你寫不好文章的問題核心不在於「輸出」,在於輸入,沒有海量的輸入,你很難獲得持續、高強度的輸出。沒有中間的處理,你所能寫出的文章就是一篇流水賬。輸入是閱讀,你需要海量的閱讀;處理是思想,你需要先在大腦內進行思維的碰撞,找出自己想法中的合理與不合理。輸出是成文,將處理的結果整理成一篇洋洋灑灑的文字。
如果你對本文有什麼看法,歡迎你在文章下方評論,或掃描二維碼,加入知識星球參與討論
