產(chǎn)品文檔中，特殊標(biāo)點符號的使用建議

1. 前言

寫這篇文章的原因是我前前后后看到過好多次標(biāo)點符號之爭，同時我又是一個較真、愛折騰的人，再加上日常工作中總是會涉及到大量的文檔，寫作內(nèi)容等，所以我對標(biāo)點符號的一些理解和看法也會一些自己的心得感受。

剛好今天無意中刷到《少數(shù)派》的一篇文章，于是就趁此機會來談?wù)勎覍Ξa(chǎn)品文檔的一些特殊標(biāo)點符號的理解和看法。

日常使用特殊的標(biāo)點符號時遇到了很多疑惑，還有挺多疑惑至今沒有解決，所以此篇有拋磚引玉的作用，希望各位讀者朋友能解答我的一些疑惑。

我對標(biāo)點符號的用法鉆研的不是很深，所以此篇文章只是我個人經(jīng)驗分享之談，并非金科玉律、標(biāo)準(zhǔn)方案，請大家辯證性對待。

2. 標(biāo)點符號的標(biāo)準(zhǔn)規(guī)范

國家對標(biāo)點符號的使用是有一套專門的標(biāo)準(zhǔn)規(guī)范的，感興趣的可以去看看：

http://www.moe.gov.cn/ewebeditor/uploadfile/2015/01/13/20150113091548267.pdf

其實大多數(shù)人都不是專業(yè)的編輯或者文字工作者，所以對標(biāo)點符號的使用基本上不會過于嚴(yán)謹(jǐn)，只要能斷句、表達(dá)清楚意思即可。尤其是現(xiàn)在互聯(lián)網(wǎng)時代，文字表達(dá)的場合越來越多，很多行文方式都傾向于口語化，多元化和個性化（表情包和emoji等）。

所以國家標(biāo)準(zhǔn)更多的是適用于正規(guī)場合，而日常的工作交流等其實還是沒有那么強的約束性的。所以如果大家看到了這篇文章中有很多地方使用的標(biāo)點符號是不標(biāo)準(zhǔn)的，也不用急著跳出來批判我，畢竟這并非是一篇嚴(yán)謹(jǐn)?shù)膶W(xué)術(shù)研究論文，請大家寬容一些看待。

本文想表達(dá)的是一些我在日常寫作時，發(fā)現(xiàn)的文檔排版和特殊的標(biāo)點符號使用的一些困惑，以及我的解決方案。

標(biāo)準(zhǔn)的標(biāo)點符號使用規(guī)范可以看上方的鏈接，這里就不再過多的討論了。

3. 日常寫作中，我的幾點困惑

1. 直角引號和彎引號

「」和“”之爭由來已久，最早的大規(guī)模爭論應(yīng)該是發(fā)生在2012年左右的知乎上。直角派和彎角派爭論了很久還是無法統(tǒng)一，但是越來越多的社區(qū)開始學(xué)習(xí)知乎的方式，使用直角引號來替代彎引號了。

我個人其實是更偏向于使用直角引號「」的，一方面是美觀的問題，另外一方面是識別性高（有些字體全角和半角的彎引號很相似）。但是隨之而來的困擾也來了，最大的一個困擾就是：

?

很多人都不知道如何輸入「」這個符號，Mac可以直接鍵盤使用Shift+【】來輸入，而其他的一些輸入法可能需要使用一些特殊方式才能方便輸入這個符號。

很多文檔是需要協(xié)作性工作的，如果我習(xí)慣性使用「」，而有一些同事習(xí)慣使用“”，那么這樣協(xié)作出來的文檔肯定會不太美觀。

2. 中英文混排的問題

中英文混排其實有很多人都不知道中英文混排的規(guī)則應(yīng)該是怎么樣的，不僅僅是空格的問題，還有一些斷句的符號怎么選擇也是很多人不知道的。我上次在知乎上無意中看到一個答案，大概的意思是：

?

如果全文是以中文為基調(diào)的，那么應(yīng)該以全角標(biāo)點符號為主體。

在Github上也有相關(guān)的指北，具體可以看下方的鏈接：

• https://github.com/mzlogin/chinese-copywriting-guidelines

很多程序員、產(chǎn)品經(jīng)理可能都聽說過中英文混排加空格的規(guī)則，但是講實話對于經(jīng)常要寫文章的人來說，加空格其實比較麻煩，會對寫作的流暢性有所影響。而且這個能遵守這個規(guī)范的人還是少數(shù)，這樣就會導(dǎo)致在協(xié)作的時候，有些人辛辛苦苦加空格；有些人一路寫到底，壓根不加空格。

難以統(tǒng)一行文風(fēng)格，一直是團隊文檔協(xié)作的難題之一。 尤其是本職工作已經(jīng)很多的情況下，如果還要對標(biāo)點符號吹毛求疵，很容易被團隊小伙伴「圍毆致死」。

所以我選擇尊重團隊中大多數(shù)人的習(xí)慣，中英文混排時不加空格，但這也許在另外一個團隊中就是不被認(rèn)可的了。

3. 操作文檔的一堆名詞怎么寫

其實無論是直角引號還是彎角引號，中英文混排加空格還是不加空格，其實更多的是影響文章閱讀的美觀性而已。但是操作文檔中的一堆名詞寫作，如果沒有使用好「準(zhǔn)確」的標(biāo)點符號，可能就會引起歧義或者讓閱讀者感到吃力。

語雀使用「」來突出一些操作、按鈕或者關(guān)鍵名詞。

蘋果使用“”來標(biāo)記相關(guān)的App、頁面、操作、按鈕或者關(guān)鍵名詞等。

菜鳥使用【】來標(biāo)記相關(guān)的操作、按鈕或者關(guān)鍵名詞等。

以上是我隨手找的三個操作文檔的案例，總體上來看，似乎代表著「三大流派」。

優(yōu)點是統(tǒng)一性很強，都凸顯了專有的名詞和信息；

缺點是統(tǒng)一性太強了，導(dǎo)致分不清代表的分別是什么（是可以接受的缺點）。例如蘋果官網(wǎng)的那張圖“設(shè)置”>“蜂窩網(wǎng)絡(luò)”>“蜂窩數(shù)據(jù)選項”，其中「設(shè)置」是代表一個App，而「蜂窩網(wǎng)絡(luò)」和「蜂窩數(shù)據(jù)選項」是一個菜單選項。對于一些不熟悉的用戶來說，第一印象可能會不太好區(qū)分「設(shè)置」到底是指什么？當(dāng)然這是我吹毛求疵的看法，我本人還是很認(rèn)可蘋果的這種做法的。

4. 我總結(jié)的特殊標(biāo)點符號的規(guī)范

頁面

當(dāng)描述的內(nèi)容包含某個菜單頁面的時候，建議使用「」或者“”，后面增加名詞修飾。

?

• 如需要完成某功能，請打開OMS的「訂單管理」頁面……
• 如需要完成某功能，請打開OMS的“訂單管理”頁面……

Tab欄或狀態(tài)

當(dāng)描述的內(nèi)容包含了某個頁面下的Tab信息或狀態(tài)的時候，建議使用「」或者“”，后面增加名詞修飾。

?

• 若要查詢預(yù)報失敗的訂單，請打開OMS的「訂單管理」頁面，切換到「暫存」Tab狀態(tài)下，即可查看相應(yīng)的訂單……
• 若要查詢預(yù)報失敗的訂單，請打開OMS的“訂單管理”頁面，切換到“暫存”Tab狀態(tài)下，即可查看相應(yīng)的訂單……

字段或者行內(nèi)代碼

當(dāng)描述的內(nèi)容包含某個新增的字段的時候，建議使用 反引號（`code`）來表示。

?

• 本接口需要新增一個字段效期信息，用來展示具體SKU的效期信息，以便于客戶可以查詢到相應(yīng)的數(shù)據(jù)……

按鈕或者功能

當(dāng)描述的內(nèi)容中需要點擊某個按鈕或者使用某個功能的時候，建議使用【】來表示，不建議使用「」是怕直角引號太多，代表的含義太雜引起閱讀負(fù)擔(dān)。

?

• 當(dāng)訂單復(fù)核完成之后，需要點擊按鈕【錄入裝箱信息】，按實際裝箱的情況如實填寫……

組合示例

當(dāng)一段描述中包含上述所有關(guān)鍵詞時，甚至還有一些特殊的情況時，可以靈活變動，使用括號()，直角引號「」或彎角引號“”（但是不建議同時出現(xiàn)直角和彎角引號），或者使用加粗，下劃線，文字顏色，背景顏色等。

?

• 先打開WMS的「訂單攔截與取消」頁面，然后進入“待處理”狀態(tài)下，找到相應(yīng)的訂單。點擊【確認(rèn)并下發(fā)】，數(shù)據(jù)就會傳遞到PDA中，當(dāng)返庫上架完成了之后，就會將狀態(tài)變更為「已取消」。所以需要增加一個字段處理類型，用來區(qū)分是系統(tǒng)自動觸發(fā)了取消，還是正常的攔截返庫而取消……

5. 總結(jié)

上面總結(jié)的一些規(guī)范，僅適用于某些很小眾的場景下，大多數(shù)情況下只需要遵守標(biāo)點符號的標(biāo)準(zhǔn)規(guī)則即可。若按標(biāo)準(zhǔn)規(guī)則來判定，里面的一些符號用的也不是很標(biāo)準(zhǔn)。但是苦于這一塊的信息太少了，可交流的機會并不多，所以我只能先摸索著前行，后續(xù)再看實際情況而迭代更新了。

上述內(nèi)容都是基于Markdown的編輯形式，如果是使用富文本的方式，那么有一些樣式或者符號可能不支持。對于產(chǎn)品經(jīng)理來說，我建議無論是需求文檔還是操作手冊，還是一些日常的經(jīng)驗沉淀積累，都用Markdown來寫。

至于原因是什么？自己查一下，體驗一下就會知道了。

如果你有更好的規(guī)范或者見解，歡迎與我私聊交流，因為這一塊的疑惑已經(jīng)困擾我很久了，我也想聽聽各位大佬的意見。

6. 參考資料

《少數(shù)派寫作排版指南》

• https://sspai.com/post/37815

《別再用「六個點」當(dāng)省略號了，這些標(biāo)點都有更規(guī)范的輸入方式》

• https://sspai.com/post/45516

《設(shè)計師與標(biāo)點符號》

• https://www.bilibili.com/video/BV1AX4y1u7Ag