程序員讀技術類書籍如何做筆記? - 知乎
我是如何寫好一篇技術博客的 - 簡書
技術博客,該寫些什么? - 知乎
前言
最近翻翻以前的博客和筆記,都覺得寫的不好。工作這么多年,其實一直都有想做成知識系列或者出書的打算,一方面是專業知識差了些,一方面就是筆記文筆寫的不好。抽了點時間,專門寫篇文章研究一下程序員如何寫技術博客。
目錄
一、寫作之前
1.寫作目標
2.寫作內容
二、寫作之中
1.列出提綱和主要觀點
2.按模板順序行文
三、寫作之后
1.優化文章內容和觀點
2.優化標題
3.優化前言和總結
4.優化排版
四、總結
附錄:寫作模板
一、寫作之前
在閱讀技術類書籍時,做筆記是一個非常重要的技能,可以幫助我們更好地理解和記憶所學內容。
1.寫作目標
明確目的:在開始閱讀之前,明確做筆記的目的,有助于有針對性地進行筆記。
通常有兩種目的:
1)加深理解、記憶關鍵概念、備忘重要步驟。選擇泛讀即可,將關鍵點記錄下來;
2)實踐和應用。建議泛讀一遍,再仔細通讀一遍。泛讀時找到你感興趣的內容,仔細通讀時則記錄筆記,為實踐和應用打下基礎。
明確類型:在筆記寫作前,需要明確受眾群體,有助于針對性進行閱讀。
通常的技術文章題材有3種:
1)技術介紹類
從實用角度介紹新技術,風格類似技術文檔,面向技術小白,目標是達到即學即用。
舉例:https://www.jianshu.com/p/66b93df4b7a6
2)技術深入類
從原理角度深入分析某項技術,面向技術中級,目標是通俗易懂。
舉例:https://blog.csdn.net/guolin_blog/category_9268670.html
3)解決問題類
從實際問題出發給出解決方案,面向遇坑開發者。
2.寫作內容
1.)?使用關鍵詞和短語:抓住關鍵詞和短語,尤其是技術術語和重要概念。將它們記錄下來,并在旁邊加上自己的理解或關聯的信息。
2.)維護結構化筆記:使用清晰的標題和子標題來組織你的筆記,確保它們具有結構性。這樣做有助于后續的復習和查找。
3.)?實踐和示例:如果書中包含實際的代碼示例或案例研究,將它們記錄下來,并嘗試在自己的開發環境中實踐。在筆記中標注關鍵的代碼片段和解釋。
4.)?使用圖表和圖像:如果書中包含圖表、圖像或表格,嘗試在筆記中重繪或描述它們。這有助于加深對視覺信息的理解。
5.)?個人注解和想法:在適當的地方,添加自己的注解和想法。這有助于將書中的概念與你自己的經驗聯系起來,并提高記憶的粘性。
二、寫作之中
1.前言和目錄
前言的意圖在于告知文章方向及受眾人群。對于問題類,直接列出要解決的問題。
目錄可以使用腦圖或書本目錄
2.列出提綱
提綱的目的在于觀點邏輯的完整性及重點部分
3.寫作手法
總分總
4.引用鏈接
引用他人文章時,文末或文中添加鏈接。盡量少的大段引用,注意自身文章的完整性。
三、寫作之后
1.優化內容
從讀者角度閱讀,檢查是否連貫,邏輯清晰,去重冗余。技術介紹類重介紹和實踐,技術深入類重完整性及易讀性,解決問題類重問題場景及解決步驟清晰度。
圖文并茂、軟硬件版本號
2.優化標題
簡單準確,同一個系列使用相關格式列表
3.優化前言和總結
前言清晰有趣,總結簡短完整
4.優化排版
突出重點關鍵字和次級標題
按照通用模板
附錄:
1.技術介紹類模板
前言
目錄
一、介紹
1.?MVVM介紹
二、實戰
三、更多
四、總結