阮一峰 中文技術文件的寫作規範

2021-08-28 01:52:57 字數 411 閱讀 3004

很多人說,不知道怎麼寫文件,都是憑著感覺寫。

網上也很少有資料,教你寫文件。這已經影響了中文軟體的發展。

我就動手,參考上面的規範,也結合自己的實踐,總結了乙份簡單的《中文技術文件的寫作規範》。

標題文字

段落數值

標點符號

章節結構

下面是關於寫作風格的乙個片段。歡迎提交 issue 和 pr 補充。

******************************===

寫作風格

(摘自《中文技術文件的寫作規範》)

如果使用了被動語態,應考慮更改為主動語態。

不使用非正式的語言風格。

用對"的"、"地"、"得"。

使用代詞時(比如"其"、"該"、"此"、"這"等詞),必須明確指代的內容,保證只有乙個含義。

中文技術文件的寫作規範

很多人說,不知道怎麼寫文件,都是憑著感覺寫。網上也很少有資料,教你寫文件。這已經影響了中文軟體的發展。我就動手,參考上面的規範,也結合自己的實踐,總結了乙份簡單的 中文技術文件的寫作規範 標題 文字段落 數值標點符號 章節結構 下面是關於寫作風格的乙個片段。歡迎提交 issue 和 pr 補充。摘自...

值得學習的技術人 阮一峰

說起阮一峰,很多it人都很熟悉,不少人都從他那深入淺出的部落格中受益匪淺,但有多少人對他做過深入的了解呢?阮一峰,70後,英文名frank。他原是上海財經大學世界經濟博士研究生。主要研究巨集觀金融 貨幣政策與美國經濟。於2008年6月獲得博士學位。目前在上海一所當地大學 上海金融學院 國際經貿學院 ...

中文技術文件的規範 標題

標題分為四個層級 下面是示例 一級標題 二級標題 標題 四級標題 1 一級標題下,不能直接出現 標題。一級標題 標題 2 標題要避免孤立編號 即同級標題只有乙個 二級標題 a 標題 a 二級標題 b 3 下級標題不重複上一級標題的名字。概述 概述 4 謹慎使用四級標題,盡量避免出現,保持層級的簡單,...