如何写好技术文档 - 排版格式和规范(一)
本文參考谷歌開(kāi)發(fā)文檔風(fēng)格指南、Vue官方文檔、React官方文檔、掘金小冊(cè)和阮一峰《中文技術(shù)文檔的寫(xiě)作規(guī)范》,其中排版格式,主要參照Vue、React官網(wǎng),寫(xiě)作規(guī)范部分主要參考阮一峰老師的《中文技術(shù)文檔的寫(xiě)作規(guī)范》。
編寫(xiě)技術(shù)文檔除了排版格式和規(guī)范,思路和風(fēng)格也極為重要,目前一些親和、幽默的寫(xiě)作風(fēng)格往往能獲得更多的閱讀量。
本文主要分為以下部分展開(kāi):
- 排版格式和規(guī)范
- 寫(xiě)作思路
- 寫(xiě)作風(fēng)格
技術(shù)文檔通常使用markdown編寫(xiě),所以后面的內(nèi)容都是針對(duì)Markdown文檔進(jìn)行排版。
同時(shí)排版格式和寫(xiě)作規(guī)范有很多重合部分,所以放在一篇文章說(shuō)明。
文檔結(jié)構(gòu)
以Vue、React官網(wǎng)為例,通常包含下面的文檔結(jié)構(gòu),如果要寫(xiě)一個(gè)開(kāi)源軟件的官方文檔,可以參考:
- 開(kāi)始:包含簡(jiǎn)介和快速上手
- 基礎(chǔ):應(yīng)用基礎(chǔ)使用
- 深入:進(jìn)階說(shuō)明
- API:API文檔
- FAQ:常見(jiàn)問(wèn)題解答
- 參考:參考連接
標(biāo)題
一篇文章主題應(yīng)專(zhuān)一,如果出現(xiàn)多個(gè)主題,編寫(xiě)多篇文章是更好的選擇,主題專(zhuān)一之后,對(duì)應(yīng)的標(biāo)題才會(huì)簡(jiǎn)潔明了。
應(yīng)避免標(biāo)題層級(jí)過(guò)多,盡量少使用 3 級(jí)標(biāo)題,最好不使用 4 級(jí)標(biāo)題。
標(biāo)題通常分為 4 級(jí):
- 一級(jí)標(biāo)題:通常不寫(xiě)在文章內(nèi)部,而是作為文章的標(biāo)題顯示在固定的標(biāo)題位置。
- 二級(jí)標(biāo)題:文章內(nèi)部主要使用的標(biāo)題,類(lèi)似Vue、React官方文檔中,絕大多數(shù)文章內(nèi)只使用了二級(jí)標(biāo)題。
- 三級(jí)標(biāo)題:二級(jí)標(biāo)題下的細(xì)分標(biāo)題,一般在長(zhǎng)文章中使用,中短篇文章如果標(biāo)題設(shè)置合理,不需要使用。
- 四級(jí)標(biāo)題:三級(jí)標(biāo)題下的細(xì)分標(biāo)題,不推薦使用,如果書(shū)寫(xiě)文章時(shí)發(fā)現(xiàn)需要使用到四級(jí)標(biāo)題,應(yīng)查看你的每個(gè)二級(jí)標(biāo)題是否屬于不同的主題,能否拆分為多篇文章。
下面是標(biāo)題使用規(guī)范:
1.標(biāo)題下應(yīng)進(jìn)行一些必要性簡(jiǎn)述,不應(yīng)該直接多層標(biāo)題重疊。
示例:下面的一、二、三級(jí)標(biāo)題直接放在一起。
結(jié)構(gòu)一
# 一級(jí)標(biāo)題
## 二級(jí)標(biāo)題
### 三級(jí)標(biāo)題
結(jié)構(gòu)二
# 一級(jí)標(biāo)題
這是一級(jí)標(biāo)題的相關(guān)描述,可以是簡(jiǎn)述下面二級(jí)大概包括的內(nèi)容。
## 二級(jí)標(biāo)題
這是二級(jí)標(biāo)題的相關(guān)描述。
### 三級(jí)標(biāo)題
2.一級(jí)標(biāo)題下,不能直接出現(xiàn)三級(jí)標(biāo)題,不要跨級(jí)使用標(biāo)題。
示例:下面的文章結(jié)構(gòu),缺少二級(jí)標(biāo)題。
# 一級(jí)標(biāo)題
### 三級(jí)標(biāo)題
3.標(biāo)題要避免孤立編號(hào)(即同級(jí)標(biāo)題只有一個(gè))。
示例:下面的文章結(jié)構(gòu),二級(jí)標(biāo)題 A只包含一個(gè)三級(jí)標(biāo)題,完全可以省略三級(jí)標(biāo)題 A。
## 二級(jí)標(biāo)題 A
### 三級(jí)標(biāo)題 A
## 二級(jí)標(biāo)題 B
4.下級(jí)標(biāo)題不重復(fù)上一級(jí)標(biāo)題的名字。
示例:下面的文章結(jié)構(gòu),二級(jí)標(biāo)題與下屬的三級(jí)標(biāo)題同名,建議避免。
## 概述
### 概述
5.盡量少使用三級(jí)標(biāo)題,不推薦使用四級(jí)標(biāo)題,保持層級(jí)的簡(jiǎn)單,防止出現(xiàn)過(guò)于復(fù)雜的章節(jié)。
如果三級(jí)標(biāo)題下有并列性的內(nèi)容,建議只使用項(xiàng)目列表來(lái)呈現(xiàn)。
示例:下面的結(jié)構(gòu)二要好于結(jié)構(gòu)一。結(jié)構(gòu)一適用的場(chǎng)景,主要是較長(zhǎng)篇幅的內(nèi)容。
結(jié)構(gòu)一
### 三級(jí)標(biāo)題
#### 四級(jí)標(biāo)題 A
#### 四級(jí)標(biāo)題 B
結(jié)構(gòu)二
### 三級(jí)標(biāo)題
1. 四級(jí)標(biāo)題A
2.四級(jí)標(biāo)題B
正文
正文內(nèi)包括句子、段落、圖片和列表等信息,推薦在這些內(nèi)容之間使用換行,來(lái)達(dá)到更好的閱讀效果。
標(biāo)點(diǎn)符號(hào)
標(biāo)點(diǎn)符號(hào)通用使用規(guī)范:
- 中文語(yǔ)句的標(biāo)點(diǎn)符號(hào),均應(yīng)該采取全角符號(hào),這樣可以與全角文字保持視覺(jué)的一致。
- 如果整句為英文,則該句使用英文/半角標(biāo)點(diǎn)。
- 句號(hào)、問(wèn)號(hào)、嘆號(hào)、逗號(hào)、頓號(hào)、分號(hào)和冒號(hào)不得出現(xiàn)在一行之首。
- 點(diǎn)號(hào)(句號(hào)、逗號(hào)、頓號(hào)、分號(hào)、冒號(hào))不得出現(xiàn)在標(biāo)題的末尾,而標(biāo)號(hào)(引號(hào)、括號(hào)、破折號(hào)、省略號(hào)、書(shū)名號(hào)、著重號(hào)、間隔號(hào)、嘆號(hào)、問(wèn)號(hào))可以。
1.句號(hào)使用規(guī)范
(1)中文語(yǔ)句的結(jié)尾處應(yīng)該用全角句號(hào)(。)。
(2)句子末尾用括號(hào)加注時(shí),句號(hào)應(yīng)在括號(hào)之外。
錯(cuò)誤:關(guān)于文件的輸出,請(qǐng)參照第 1.3 節(jié)(見(jiàn)第 26 頁(yè)。)
正確:關(guān)于文件的輸出,請(qǐng)參照第 1.3 節(jié)(見(jiàn)第 26 頁(yè))。
2.逗號(hào)使用規(guī)范
(1)逗號(hào)(,)表示句子內(nèi)部的一般性停頓。
注意避免“一逗到底”,即整個(gè)段落除了結(jié)尾,全部停頓都使用逗號(hào)。
3.頓號(hào)使用規(guī)范
(1)句子內(nèi)部的并列詞,應(yīng)該用全角頓號(hào)(、) 分隔,而不用逗號(hào),即使并列詞是英語(yǔ)也是如此。
錯(cuò)誤:我最欣賞的科技公司有 Google, Facebook, 騰訊, 阿里和百度等。
正確:我最欣賞的科技公司有 Google、Facebook、騰訊、阿里和百度等。
(2)英文句子中,并列詞語(yǔ)之間使用半角逗號(hào)(,)分隔。
例句:Microsoft Office includes Word, Excel, PowerPoint, Outlook and other components.
中文句子內(nèi)部的并列詞,最后一個(gè)盡量使用(和)來(lái)連接,使句子讀起來(lái)更加連貫,下面兩個(gè)句子都可以,第二個(gè)更優(yōu)。
正確:我最欣賞的科技公司有 Google、Facebook、騰訊、阿里,以及百度等。
正確:我最欣賞的科技公司有 Google、Facebook、騰訊、阿里和百度等。
4.分號(hào)使用規(guī)范
(1)分號(hào)(;)表示復(fù)句內(nèi)部并列分句之間的停頓。
5.引號(hào)使用規(guī)范
引用時(shí),應(yīng)該使用全角雙引號(hào)(“ ”),注意前后雙引號(hào)不同。
例句:許多人都認(rèn)為客戶(hù)服務(wù)的核心是“友好”和“專(zhuān)業(yè)”。
(2)引號(hào)里面還要用引號(hào)時(shí),外面一層用雙引號(hào),里面一層用單引號(hào)(‘ ’),注意前后單引號(hào)不同。
例句:鮑勃解釋道:“我要放音樂(lè),可薩利說(shuō),‘不行!’。”
6.括號(hào)使用規(guī)范
(1)補(bǔ)充說(shuō)明時(shí),使用全角圓括號(hào)(()),括號(hào)前后不加空格。
例句:請(qǐng)確認(rèn)所有的連接(電纜和接插件)均安裝牢固。
幾種括號(hào)的中英文名稱(chēng)。
| 英文 | 中文 | |
|---|---|---|
{ } |
braces 或 curly brackets | 大括號(hào) |
[ ] |
square brackets 或 brackets | 方括號(hào) |
< > |
angled brackets | 尖括號(hào) |
( ) |
parentheses | 圓括號(hào) |
7.冒號(hào)使用規(guī)范
(1)全角冒號(hào)(:)常用在需要解釋的詞語(yǔ)后邊,引出解釋和說(shuō)明。
例句:請(qǐng)確認(rèn)以下幾項(xiàng)內(nèi)容:時(shí)間、地點(diǎn)、活動(dòng)名稱(chēng)和來(lái)賓數(shù)量。
(2)表示時(shí)間時(shí),應(yīng)使用半角冒號(hào)(:)。
例句:早上 8:00
8.省略號(hào)使用規(guī)范
(1)省略號(hào)(??)表示語(yǔ)句未完、或者語(yǔ)氣的不連續(xù)。
(2)省略號(hào)占兩個(gè)漢字空間、包含六個(gè)省略點(diǎn),不要使用。。。或...等非標(biāo)準(zhǔn)形式。
(3)省略號(hào)不應(yīng)與“等”這個(gè)詞一起使用。
錯(cuò)誤:我們?yōu)闀?huì)餐準(zhǔn)備了香蕉、蘋(píng)果、梨…等各色水果。
正確:我們?yōu)闀?huì)餐準(zhǔn)備了各色水果,有香蕉、蘋(píng)果、梨??
正確:我們?yōu)闀?huì)餐準(zhǔn)備了香蕉、蘋(píng)果、梨等各色水果。
9.感嘆號(hào)使用規(guī)范
(1)應(yīng)該使用平靜的語(yǔ)氣敘述,盡量避免使用感嘆號(hào)(!)。
(2)不得多個(gè)感嘆號(hào)連用,比如!!和!!!。
10.破折號(hào)使用規(guī)范
(1)破折號(hào)————一般用于進(jìn)一步解釋。
(2)破折號(hào)應(yīng)占兩個(gè)漢字的位置。如果破折號(hào)本身只占一個(gè)漢字的位置,那么前后應(yīng)該留出一個(gè)半角空格。
例句:直覺(jué)————盡管它并不總是可靠的————告訴我,這事可能出了些問(wèn)題。
例句:直覺(jué) —— 盡管它并不總是可靠的 —— 告訴我,這事可能出了些問(wèn)題。
11.連接號(hào)使用規(guī)范
(1)連接號(hào)用于連接兩個(gè)類(lèi)似的詞。
(2)以下場(chǎng)合應(yīng)該使用直線(xiàn)連接號(hào)(-),占一個(gè)半角字符的位置。
- 兩個(gè)名詞的復(fù)合
- 圖表編號(hào)
例句:氧化-還原反應(yīng)
例句:圖 1-1
(3)數(shù)值范圍(例如日期、時(shí)間或數(shù)字)應(yīng)該使用波浪連接號(hào)(~)或一字號(hào)(—),占一個(gè)全角字符的位置。
例句:2009 年~2011 年
注意,波浪連接號(hào)前后兩個(gè)值都建議加上單位。
(4)波浪連接號(hào)也可以用漢字“至”代替。
例句:周?chē)鷾囟龋?20 °C 至 -10 °C
文本
markdown中文本排版直接從最左側(cè)開(kāi)始即可,不用空兩個(gè)字。
下面是文本的使用規(guī)范:
1.少量使用文本加粗。
一定是非常重要的內(nèi)容才使用加粗,隨意使用將導(dǎo)致整個(gè)文章顯示效果不佳,同時(shí)重點(diǎn)內(nèi)容也不明顯。
2.全角中文字符與半角英文字符之間,應(yīng)有一個(gè)半角空格。
錯(cuò)誤:本文介紹如何快速啟動(dòng)Windows系統(tǒng)。
正確:本文介紹如何快速啟動(dòng) Windows 系統(tǒng)。
3.全角中文字符與半角阿拉伯?dāng)?shù)字之間,有沒(méi)有半角空格都可,但必須保證風(fēng)格統(tǒng)一,不能兩種風(fēng)格混雜。
正確:2011年5月15日,我訂購(gòu)了5臺(tái)筆記本電腦與10臺(tái)平板電腦。
正確:2011 年 5 月 15 日,我訂購(gòu)了 5 臺(tái)筆記本電腦與 10 臺(tái)平板電腦。
半角的百分號(hào),視同阿拉伯?dāng)?shù)字。
正確:今年我國(guó)經(jīng)濟(jì)增長(zhǎng)率是6.5%。
正確:今年我國(guó)經(jīng)濟(jì)增長(zhǎng)率是 6.5%。
4.英文單位若不翻譯,單位前的阿拉伯?dāng)?shù)字與單位符號(hào)之間,應(yīng)留出適當(dāng)?shù)目障丁?/p>
例1:一部容量為 16 GB 的智能手機(jī)
例2:1 h = 60 min = 3,600 s
5.半角英文字符和半角阿拉伯?dāng)?shù)字,與全角標(biāo)點(diǎn)符號(hào)之間不留空格。
錯(cuò)誤:他的電腦是 MacBook Air 。
正確:他的電腦是 MacBook Air。
數(shù)值
1.阿拉伯?dāng)?shù)字一律使用半角形式,不得使用全角形式。
錯(cuò)誤:這件商品的價(jià)格是1000元。
正確:這件商品的價(jià)格是 1000 元。
2.數(shù)值為千位以上,應(yīng)添加千分號(hào)(半角逗號(hào))。
XXX 公司的實(shí)收資本為 ¥1,258,000 人民幣。
對(duì)于 4 位的數(shù)值,千分號(hào)是選用的,比如1000和1,000都可以接受。對(duì)于 4 位以上的數(shù)值,應(yīng)添加千分號(hào)。
3.貨幣應(yīng)為阿拉伯?dāng)?shù)字,并在數(shù)字前寫(xiě)出貨幣符號(hào),或在數(shù)字后寫(xiě)出貨幣中文名稱(chēng)。
$1,000
1,000 美元
4.表示數(shù)值范圍時(shí),用波浪線(xiàn)(~)或一字線(xiàn)(—)連接。參見(jiàn)《標(biāo)點(diǎn)符號(hào)》一節(jié)的“連接號(hào)”部分。
帶有單位或百分號(hào)時(shí),兩個(gè)數(shù)字建議都要加上單位或百分號(hào)。
132 kg~234 kg
67%~89%
5.數(shù)字的增加要使用“增加了”、“增加到”。“了”表示增量,“到”表示定量。
增加到過(guò)去的兩倍
(過(guò)去為一,現(xiàn)在為二)
增加了兩倍
(過(guò)去為一,現(xiàn)在為三)
6.數(shù)字的減少要使用“降低了”、“降低到”。“了”表示增量,“到”表示定量。
降低到百分之八十
(定額是一百,現(xiàn)在是八十)
降低了百分之八十
(原來(lái)是一百,現(xiàn)在是二十)
不能用“降低 N 倍”或“減少 N 倍”的表示法,要用“降低百分之幾”或“減少百分之幾”。因?yàn)闇p少(或降低)一倍表示數(shù)值原來(lái)為一百,現(xiàn)在等于零。
句子
句子使用規(guī)范:
1.避免使用長(zhǎng)句。
不包含任何標(biāo)點(diǎn)符號(hào)的單個(gè)句子,或者以逗號(hào)分隔的句子構(gòu)件,長(zhǎng)度盡量保持在 20 個(gè)字以?xún)?nèi);20~29 個(gè)字的句子,可以接受;30~39 個(gè)字的句子,語(yǔ)義必須明確,才能接受;多于 40 個(gè)字的句子,任何情況下都不能接受。
錯(cuò)誤:本產(chǎn)品適用于從由一臺(tái)服務(wù)器進(jìn)行動(dòng)作控制的單一節(jié)點(diǎn)結(jié)構(gòu)到由多臺(tái)服務(wù)器進(jìn)行動(dòng)作控制的并行處理程序結(jié)構(gòu)等多種體系結(jié)構(gòu)。
正確:本產(chǎn)品適用于多種體系結(jié)構(gòu)。無(wú)論是由一臺(tái)服務(wù)器(單一節(jié)點(diǎn)結(jié)構(gòu)),還是由多臺(tái)服務(wù)器(并行處理結(jié)構(gòu))進(jìn)行動(dòng)作控制,均可以使用本產(chǎn)品。
逗號(hào)分割的長(zhǎng)句,總長(zhǎng)度不應(yīng)該超過(guò) 100 字或者正文的 3 行。
2.盡量使用簡(jiǎn)單句和并列句,避免使用復(fù)合句。
并列句:他昨天生病了,沒(méi)有參加會(huì)議。
復(fù)合句:那個(gè)昨天生病的人沒(méi)有參加會(huì)議。
3.同樣一個(gè)意思,盡量使用肯定句表達(dá),不使用否定句表達(dá)。
錯(cuò)誤:請(qǐng)確認(rèn)沒(méi)有接通裝置的電源。
正確:請(qǐng)確認(rèn)裝置的電源已關(guān)閉。
4.避免使用雙重否定句。
錯(cuò)誤:沒(méi)有刪除權(quán)限的用戶(hù),不能刪除此文件。
正確:用戶(hù)必須擁有刪除權(quán)限,才能刪除此文件。
下面再看看英文的處理規(guī)范:
1.英文原文如果使用了復(fù)數(shù)形式,翻譯成中文時(shí),應(yīng)該將其還原為單數(shù)形式。
英文:...information stored in random access memory (RAMs)...
中文:??存儲(chǔ)在隨機(jī)存取存儲(chǔ)器(RAM)里的信息??
2.外文縮寫(xiě)可以使用半角圓點(diǎn)(.)表示縮寫(xiě)。
U.S.A.
Apple, Inc.
3.表示中文時(shí),英文省略號(hào)(...)應(yīng)改為中文省略號(hào)(??)。
英文:5 minutes later...
中文:5 分鐘過(guò)去了??
4.英文書(shū)名或電影名改用中文表達(dá)時(shí),雙引號(hào)應(yīng)改為書(shū)名號(hào)。
英文:He published an article entitled "The Future of the Aviation".
中文:他發(fā)表了一篇名為《航空業(yè)的未來(lái)》的文章。
5.第一次出現(xiàn)英文詞匯時(shí),在括號(hào)中給出中文標(biāo)注。此后再次出現(xiàn)時(shí),直接使用英文縮寫(xiě)即可。
IOC(International Olympic Committee,國(guó)際奧林匹克委員會(huì))。這樣定義后,便可以直接使用“IOC”了。
6.專(zhuān)有名詞中每個(gè)詞第一個(gè)字母均應(yīng)大寫(xiě),非專(zhuān)有名詞則不需要大寫(xiě)。
“American Association of Physicists in Medicine”(美國(guó)醫(yī)學(xué)物理學(xué)家協(xié)會(huì))是專(zhuān)有名詞,需要大寫(xiě)。
“online transaction processing”(在線(xiàn)事務(wù)處理)不是專(zhuān)有名詞,不應(yīng)大寫(xiě)。
段落
下面是段落的寫(xiě)作規(guī)范:
- 一個(gè)段落只能有一個(gè)主題,或一個(gè)中心句子。
- 段落的中心句子放在段首,對(duì)全段內(nèi)容進(jìn)行概述。后面陳述的句子為中心句子服務(wù)。
- 一個(gè)段落的長(zhǎng)度不能超過(guò)七行,最佳段落長(zhǎng)度小于等于四行。
- 段落的句子語(yǔ)氣要使用陳述和肯定語(yǔ)氣,避免使用感嘆語(yǔ)氣。
- 段落之間使用一個(gè)空行隔開(kāi)。
- 段落開(kāi)頭不要留出空白字符。
列表
列表包含無(wú)序列表和有序列表,推薦使用下面的規(guī)范:
1.必須是并列和遞進(jìn)關(guān)系的內(nèi)容,才使用列表。
絕大多數(shù)內(nèi)容其實(shí)并不需要使用列表,查看React官方文檔,知識(shí)點(diǎn)基本使用了大量的正文進(jìn)行描述,其中并沒(méi)有用小標(biāo)題和列表進(jìn)行分隔。
除非內(nèi)容存在并列和遞進(jìn)關(guān)系,并且僅僅是簡(jiǎn)單羅列,才考慮使用列表,以Vue官方文檔為例,API文檔中,一個(gè)對(duì)象包含多個(gè)函數(shù)和屬性,它們是并列關(guān)系,但并不需要采用列表來(lái)表示,使用標(biāo)題分隔是更佳的選擇。
當(dāng)確定要使用列表時(shí),注意并列關(guān)系時(shí)使用無(wú)序列表,遞進(jìn)關(guān)系使用有序列表。
2.列表之間不要添加內(nèi)容,緊密結(jié)合在一起展示。
列表應(yīng)該盡可能直觀(guān)的排列在一起,如果列表之前需要添加內(nèi)容,那么應(yīng)該考慮將列表項(xiàng)換成標(biāo)題。
本文前面內(nèi)容就是一個(gè)反例,列表項(xiàng)之間添加了列表的一些描述,主要原因是本文是一個(gè)匯總式文章,每個(gè)列表項(xiàng)之間僅是簡(jiǎn)單敘述,如果存在大量描述的話(huà),應(yīng)該使用標(biāo)題來(lái)代替列表項(xiàng)名。
其它markdown內(nèi)容
引用
因?yàn)閙arkdown擁有的格式種類(lèi)還是比較有限,所以引用標(biāo)簽除了引用第三方內(nèi)容外,通常還可以用于顯示一些提示、警告、總結(jié)等信息。
Vue和React官方不是單純的markdown格式,所以可以使用更豐富的css來(lái)顯示這部分內(nèi)容。
如:
提示
這里是提示內(nèi)容,和上面的提示最好隔一行。
下面是引用第三方內(nèi)容時(shí)使用規(guī)范:
1.引用第三方內(nèi)容時(shí),應(yīng)注明出處。
One man’s constant is another man’s variable. — Alan Perlis
2.如果是全篇轉(zhuǎn)載,請(qǐng)?jiān)谌拈_(kāi)頭顯著位置注明作者和出處,并鏈接至原文。
本文轉(zhuǎn)載自 WikiQuote
3.使用外部圖片時(shí),必須在圖片下方或文末標(biāo)明來(lái)源。
本文部分圖片來(lái)自 Wikipedia
代碼
代碼包含句子中提及的關(guān)鍵詞代碼和大段的演示代碼。
1.句子中提及的代碼,應(yīng)盡量少用代碼標(biāo)簽包裹。
一個(gè)句子中可能提及很多代碼關(guān)鍵詞,但是只用 code 標(biāo)簽包裹當(dāng)前上下文關(guān)注的代碼關(guān)鍵詞是更好的選擇,高亮過(guò)多代碼關(guān)鍵詞整個(gè)句子看起來(lái)會(huì)雜亂。
2.代碼塊應(yīng)盡量選擇正確的代碼語(yǔ)言,以高亮正確的關(guān)鍵字。
總結(jié)
以上是生活随笔為你收集整理的如何写好技术文档 - 排版格式和规范(一)的全部?jī)?nèi)容,希望文章能夠幫你解決所遇到的問(wèn)題。
- 上一篇: 神经网络优化篇:理解mini-batch
- 下一篇: 还在封装 xxxForm,xxxTabl