【實操指南】一分鐘學會技術文章的排版

寫代碼要追求簡潔、優(yōu)美，寫中文文章更是如此。

當一篇文章看上去令人賞心悅目，其傳播效果也必然事半功倍。

為此，我們綜合了一些約定俗成的中文寫作規(guī)范要求，幫助大家提升對文字排版的認識。學以致用，讓你的技術文章看起來更專業(yè)、嚴謹，閱讀量節(jié)節(jié)攀升。

以下為業(yè)內(nèi)通用的排版規(guī)范建議，供大家參考。

劃重點：給標題分好類

了解標題層級

標題分為四級。

一級標題：文章的標題

二級標題：文章主要部分的大標題

三級標題：二級標題下面一級的小標題

四級標題：三級標題下面某一方面的小標題

使用原則

1、一級標題下，不能直接出現(xiàn)三級標題

示例：下面的文章結構，缺少二級標題。

# 一級標題 ### 三級標題

2、標題要避免孤立編號（即同級標題只有一個）

示例：下面的文章結構，二級標題 A只包含一個三級標題，完全可以省略三級標題 A。

## 二級標題 A ### 三級標題 A ## 二級標題 B

3、下級標題不重復上一級標題的名字

示例：下面的文章結構，二級標題與下屬的三級標題同名，建議避免。

## 概述 ### 概述

4、謹慎使用四級標題，盡量避免出現(xiàn)，保持層級的簡單，防止出現(xiàn)過于復雜的章節(jié)

如果三級標題下有并列性的內(nèi)容，建議只使用項目列表（Item list）。

示例：下面的結構二要好于結構一。結構一適用的場景，主要是較長篇幅的內(nèi)容。

結構一 ### 三級標題 #### 四級標題 A #### 四級標題 B #### 四級標題 C 結構二 ### 三級標題 **（1）A** **（2）B** **（3）C**

正文里有中、英文、數(shù)字時，這些要注意

需要加空格的

1、中英文之間需要增加空格

正確：

論文已被 NeurIPS 2020 錄用，代碼已基于 MindSpore 開源首發(fā)。

錯誤：

論文已被NeurIPS 2020錄用，代碼已基于MindSpore開源首發(fā)。

例外：「豆瓣FM」等產(chǎn)品名詞，按照官方所定義的格式書寫。

2、中文與數(shù)字之間需要增加空格

正確：

今天出去買菜花了 5000 元。

錯誤：

今天出去買菜花了5000元。

不需要加空格

1、數(shù)字與單位之間無需增加空格

正確：

我家的光纖入戶寬帶有 10Gbps，SSD 一共有 10TB。

錯誤：

我家的光纖入戶寬帶有 10 Gbps，SSD 一共有 20 TB。

另外，度／百分比與數(shù)字之間不需要增加空格：

正確：

今天是 233° 的高溫。

新的筆記本有 15% 的 CPU 性能提升。

錯誤：

今天是 233 ° 的高溫。

新的筆記本有 15 % 的 CPU 性能提升。

2、全角標點與其他字符之間不加空格

正確：

有些文獻中定義成 reward，那么 reward 的負數(shù)就對應此處的損失值。

錯誤：

有些文獻中定義成 reward ，那么 reward 的負數(shù)就對應此處的損失值。

標點符號，你用對了嗎？

使用原則

1、中文語句的標點符號，均應該采取全角符號，這樣可以與全角文字保持視覺的一致。

2、如果整句為英文，則該句使用英文/半角標點。

3、句號、問號、嘆號、逗號、頓號、分號和冒號不得出現(xiàn)在一行之首。

4、點號（句號、逗號、頓號、分號、冒號）不得出現(xiàn)在標題的末尾，而標號（引號、括號、破折號、省略號、書名號、著重號、間隔號、嘆號、問號）可以。

5、不重復使用相同的標點符號來顯示強調(diào)突出，比如多個感嘆號連用。

省略號

1、省略號占兩個漢字空間、包含六個省略點，不要使用。。。或...等非標準形式。

正確：

中國設計還有太長路要走……

錯誤：

中國設計還有太長路要走…

2、省略號不應與“等”這個詞一起使用。

正確：

我們?yōu)闀蜏蕚淞烁魃邢憬丁⑻O果、梨……

我們?yōu)闀蜏蕚淞讼憬丁⑻O果、梨等各色水果。

錯誤：

我們?yōu)闀蜏蕚淞讼憬丁⑻O果、梨…等各色水果。

破折號

1、破折號————一般用于進一步解釋。

2、破折號應占兩個漢字的位置。如果破折號本身只占一個漢字的位置，那么前后應該留出一個半角空格。

例句：直覺 —— 盡管它并不總是可靠的 —— 告訴我，這事可能出了些問題。

連接號

1、連接號用于連接兩個類似的詞。

2、以下場合應該使用直線連接號（-），占一個半角字符的位置。

兩個名詞的復合

圖表編號

例句：氧化-還原反應

例句：圖 1-1

3、數(shù)值范圍（例如日期、時間或數(shù)字）應該使用波浪連接號（～），占一個全角字符的位置。

例句：2009 年～2011 年

注意，波浪連接號前后兩個值都應該加上單位。

4、波浪連接號也可以用漢字“至”代替。

例句：周圍溫度：-20°C 至 -10°C

頓號

1、句子內(nèi)部的并列詞，應該用全角頓號(、) 分隔，而不用逗號，即使并列詞是英語也是如此。

正確：

我最欣賞的科技公司有 Google、Facebook、蘋果、華為等。

錯誤：

我最欣賞的科技公司有 Google, Facebook, 蘋果, 華為等。

2、英文句子中，并列詞語之間使用半角逗號（,）分隔。

例句：Microsoft Office includes Word, Excel, PowerPoint, Outlook and other components.

全角和半角

關于全角（全形）與半角（半形）符號的區(qū)別，可以查看維基百科詞條『全角和半角』。

使用全角中文標點

正確：

嗨！你知道嘛？今天前臺的小妹跟我說「喵」了哎！

核磁共振成像（NMRI）是什么原理都不知道？JFGI！

錯誤：

嗨! 你知道嘛? 今天前臺的小妹跟我說 “喵” 了哎!

嗨!你知道嘛?今天前臺的小妹跟我說”喵”了哎!

核磁共振成像 (NMRI) 是什么原理都不知道? JFGI!

核磁共振成像(NMRI)是什么原理都不知道?JFGI!

數(shù)字使用半角字符

正確：

這件蛋糕只賣 1000 元。

錯誤：

這件蛋糕只賣 １０００ 元。

遇到完整的英文整句、特殊名詞，其內(nèi)容使用半角標點

正確：

喬布斯那句話是怎么說的？「Stay hungry, stay foolish.」

推薦你閱讀《Hackers & Painters: Big Ideas from the Computer Age》，非常的有趣。

錯誤：

喬布斯那句話是怎么說的？「Stay hungry，stay foolish。」

推薦你閱讀《Hackers＆Painters：Big Ideas from the Computer Age》，非常的有趣。

專有名詞，寫的地道些

專有名詞使用正確的大小寫

無論是否在句首都應該以同樣的方式寫。

正確：

使用 GitHub 登錄

我們的客戶有 GitHub、Foursquare、Microsoft Corporation、Google、Facebook, Inc.。

錯誤：

使用 github 登錄

使用 GITHUB 登錄

我們的客戶有 github、foursquare、microsoft corporation、google、facebook, inc.。

我們的客戶有 GITHUB、FOURSQUARE、MICROSOFT CORPORATION、GOOGLE、FACEBOOK, INC.。

不要使用不地道的縮寫

正確：

我們需要一位熟悉 JavaScript、HTML5，至少理解一種框架（如 Backbone.js、AngularJS、React 等）的前端開發(fā)者。

錯誤：

我們需要一位熟悉 Js、h5，至少理解一種框架（如 backbone、angular、RJS 等）的 FED。

引用內(nèi)容，切記標明出處

本文轉載自華為云社區(qū)

文中有使用外站圖片，必須在文末標明。來源如果來自外站必須添加鏈接，來源如果來自外部作品則不需要。如：

本文部分圖片來自華為云

本文部分內(nèi)容編譯自 GitHub

本文部分觀點來自華為云

本文參考鏈接

中文技術文檔的寫作規(guī)范

寫作規(guī)范和格式規(guī)范

https://open.leancloud.cn/copywriting-style-guide/

AI

版權聲明：本文內(nèi)容由網(wǎng)絡用戶投稿，版權歸原作者所有，本站不擁有其著作權，亦不承擔相應法律責任。如果您發(fā)現(xiàn)本站中有涉嫌抄襲或描述失實的內(nèi)容，請聯(lián)系我們jiasou666@gmail.com 處理，核實后本網(wǎng)站將在24小時內(nèi)刪除侵權內(nèi)容。