撰寫技術文章的注意事項

2022-04-16 09:16:06 字數 738 閱讀 2802

本文將簡單介紹 技術文章的閱讀體驗 中的主要思想,為以後自己寫文章打下良好的架構基礎。評價一篇技術文章的標準是:讓符合閱讀條件的讀者,在較好的閱讀體驗下,看懂學會甚至掌握文章想要傳達的思想或技術。下面將要介紹的幾種原則都是為這個目的為服務的。

寫文章是一種傳遞資訊的方式,部落格這種非對稱的傳遞方式,讓讀者和寫者之間存在資訊不對稱,為緩解這種因不對稱而帶來的閱讀壓力,文章需要在開頭處,向讀者介紹閱讀後續內容所必須的基礎知識。如果讀者沒有這些基礎知識,在後續的閱讀中可能會遇到理解上的障礙。而對於具備這些知識的讀者來說,需要在文章的末尾,給出進一步深入學習的建議作為補充,以及列出在撰寫本文的過程中所涉及到的一些參考資料。

教學相長,要想清楚明白地講解乙個問題以及解決方法,需要對該問題的產生背景和不同的解決方案有較好的理解,每種解決方案在特定場景下都是有價值的,這種理解體現在能不能用自己的語言來通俗易懂而又清晰明白的來闡述。我現在還深刻地記得,在大學期間看到的乙個關於程序和執行緒的解釋,它是這樣說到的,程序就像是一架馬車,而執行緒就像是一匹馬,一架馬車至少有一匹馬才能跑起來,不同馬車上載的貨物各不相同,馬與馬之間,馬車與馬車之間,都是可以相互溝通的。具體出處已經不記得了,我當時看到這個模擬時,真是大為震驚,作業系統理論概念居然能和現實生活中的事物有如此巧妙的聯絡,只有既深刻理解程序/執行緒關係,又熱愛生活,善於思考的人,才能想出如此精妙的模擬,這真真是通俗易懂的語言。

在內容表現力上,文字不如**,而**不如圖形。這三者在表現力上各有各的側重點,需要根據不同的場景需要來選取使用。

撰寫技術文章的注意事項

本文將簡單介紹 技術文章的閱讀體驗 中的主要思想,為以後自己寫文章打下良好的架構基礎。評價一篇技術文章的標準是 讓符合閱讀條件的讀者,在較好的閱讀體驗下,看懂學會甚至掌握文章想要傳達的思想或技術。下面將要介紹的幾種原則都是為這個目的為服務的。寫文章是一種傳遞資訊的方式,部落格這種非對稱的傳遞方式,讓...

撰寫oracle sql hint的注意事項

有時候oracle自動生成的執行計畫是 笨 的,我們給一些提示資訊,讓oracle自動找到 聰明 的執行計畫,這就是 hint 初學者,甚至專業人員,會遇到這樣的疑惑 hint不起作用?因為oracle對於錯誤的hint是自動忽略,所以我們要特別注意hint的語法 暫列一條 如果在sql中使用了別名...

撰寫資訊書籍注意事項

l名聲第一,利益第二,不要在別人案頭留下罵名。l 書籍定位清楚,沒有適合所有人的書 l 章節目錄由簡而深,必要內容放在前面章節,選擇性內容放在後方章節。l 第一章最後寫。l 不要有漫畫書的狀況出現。在圖與圖間最好加一些引述,說明。否則書會像漫畫書 j,讀者不容易連續想象 之間的關係。l 具體不要抽象...