產(chǎn)品文檔中，特殊標(biāo)點(diǎn)符號(hào)的使用建議
1. 前言
寫這篇文章的原因是我前前后后看到過(guò)好多次標(biāo)點(diǎn)符號(hào)之爭(zhēng)，同時(shí)我又是一個(gè)較真、愛折騰的人，再加上日常工作中總是會(huì)涉及到大量的文檔，寫作內(nèi)容等，所以我對(duì)標(biāo)點(diǎn)符號(hào)的一些理解和看法也會(huì)一些自己的心得感受。
剛好今天無(wú)意中刷到《少數(shù)派》的一篇文章，于是就趁此機(jī)會(huì)來(lái)談?wù)勎覍?duì)產(chǎn)品文檔的一些特殊標(biāo)點(diǎn)符號(hào)的理解和看法。
日常使用特殊的標(biāo)點(diǎn)符號(hào)時(shí)遇到了很多疑惑，還有挺多疑惑至今沒(méi)有解決，所以此篇有拋磚引玉的作用，希望各位讀者朋友能解答我的一些疑惑。
我對(duì)標(biāo)點(diǎn)符號(hào)的用法鉆研的不是很深，所以此篇文章只是我個(gè)人經(jīng)驗(yàn)分享之談，并非金科玉律、標(biāo)準(zhǔn)方案，請(qǐng)大家辯證性對(duì)待。
2. 標(biāo)點(diǎn)符號(hào)的標(biāo)準(zhǔn)規(guī)范
國(guó)家對(duì)標(biāo)點(diǎn)符號(hào)的使用是有一套專門的標(biāo)準(zhǔn)規(guī)范的，感興趣的可以去看看：
http://www.moe.gov.cn/ewebeditor/uploadfile/2015/01/13/20150113091548267.pdf
其實(shí)大多數(shù)人都不是專業(yè)的編輯或者文字工作者，所以對(duì)標(biāo)點(diǎn)符號(hào)的使用基本上不會(huì)過(guò)于嚴(yán)謹(jǐn)，只要能斷句、表達(dá)清楚意思即可。尤其是現(xiàn)在互聯(lián)網(wǎng)時(shí)代，文字表達(dá)的場(chǎng)合越來(lái)越多，很多行文方式都傾向于口語(yǔ)化，多元化和個(gè)性化（表情包和emoji等）。
所以國(guó)家標(biāo)準(zhǔn)更多的是適用于正規(guī)場(chǎng)合，而日常的工作交流等其實(shí)還是沒(méi)有那么強(qiáng)的約束性的。所以如果大家看到了這篇文章中有很多地方使用的標(biāo)點(diǎn)符號(hào)是不標(biāo)準(zhǔn)的，也不用急著跳出來(lái)批判我，畢竟這并非是一篇嚴(yán)謹(jǐn)?shù)膶W(xué)術(shù)研究論文，請(qǐng)大家寬容一些看待。
本文想表達(dá)的是一些我在日常寫作時(shí)，發(fā)現(xiàn)的文檔排版和特殊的標(biāo)點(diǎn)符號(hào)使用的一些困惑，以及我的解決方案。
標(biāo)準(zhǔn)的標(biāo)點(diǎn)符號(hào)使用規(guī)范可以看上方的鏈接，這里就不再過(guò)多的討論了。
3. 日常寫作中，我的幾點(diǎn)困惑
1. 直角引號(hào)和彎引號(hào)
「」和“”之爭(zhēng)由來(lái)已久，最早的大規(guī)模爭(zhēng)論應(yīng)該是發(fā)生在2012年左右的知乎上。直角派和彎角派爭(zhēng)論了很久還是無(wú)法統(tǒng)一，但是越來(lái)越多的社區(qū)開始學(xué)習(xí)知乎的方式，使用直角引號(hào)來(lái)替代彎引號(hào)了。
我個(gè)人其實(shí)是更偏向于使用直角引號(hào)「」的，一方面是美觀的問(wèn)題，另外一方面是識(shí)別性高（有些字體全角和半角的彎引號(hào)很相似）。但是隨之而來(lái)的困擾也來(lái)了，最大的一個(gè)困擾就是：
?很多人都不知道如何輸入
「」這個(gè)符號(hào)，Mac可以直接鍵盤使用Shift+【】來(lái)輸入，而其他的一些輸入法可能需要使用一些特殊方式才能方便輸入這個(gè)符號(hào)。
很多文檔是需要協(xié)作性工作的，如果我習(xí)慣性使用「」，而有一些同事習(xí)慣使用“”，那么這樣協(xié)作出來(lái)的文檔肯定會(huì)不太美觀。
2. 中英文混排的問(wèn)題
中英文混排其實(shí)有很多人都不知道中英文混排的規(guī)則應(yīng)該是怎么樣的，不僅僅是空格的問(wèn)題，還有一些斷句的符號(hào)怎么選擇也是很多人不知道的。我上次在知乎上無(wú)意中看到一個(gè)答案，大概的意思是：
?如果全文是以中文為基調(diào)的，那么應(yīng)該以全角標(biāo)點(diǎn)符號(hào)為主體。
在Github上也有相關(guān)的指北，具體可以看下方的鏈接：
https://github.com/mzlogin/chinese-copywriting-guidelines
很多程序員、產(chǎn)品經(jīng)理可能都聽說(shuō)過(guò)中英文混排加空格的規(guī)則，但是講實(shí)話對(duì)于經(jīng)常要寫文章的人來(lái)說(shuō)，加空格其實(shí)比較麻煩，會(huì)對(duì)寫作的流暢性有所影響。而且這個(gè)能遵守這個(gè)規(guī)范的人還是少數(shù)，這樣就會(huì)導(dǎo)致在協(xié)作的時(shí)候，有些人辛辛苦苦加空格；有些人一路寫到底，壓根不加空格。
難以統(tǒng)一行文風(fēng)格，一直是團(tuán)隊(duì)文檔協(xié)作的難題之一。 尤其是本職工作已經(jīng)很多的情況下，如果還要對(duì)標(biāo)點(diǎn)符號(hào)吹毛求疵，很容易被團(tuán)隊(duì)小伙伴「圍毆致死」。
所以我選擇尊重團(tuán)隊(duì)中大多數(shù)人的習(xí)慣，中英文混排時(shí)不加空格，但這也許在另外一個(gè)團(tuán)隊(duì)中就是不被認(rèn)可的了。
3. 操作文檔的一堆名詞怎么寫
其實(shí)無(wú)論是直角引號(hào)還是彎角引號(hào)，中英文混排加空格還是不加空格，其實(shí)更多的是影響文章閱讀的美觀性而已。但是操作文檔中的一堆名詞寫作，如果沒(méi)有使用好「準(zhǔn)確」的標(biāo)點(diǎn)符號(hào)，可能就會(huì)引起歧義或者讓閱讀者感到吃力。
語(yǔ)雀使用「」來(lái)突出一些操作、按鈕或者關(guān)鍵名詞。
蘋果使用“”來(lái)標(biāo)記相關(guān)的App、頁(yè)面、操作、按鈕或者關(guān)鍵名詞等。
菜鳥使用【】來(lái)標(biāo)記相關(guān)的操作、按鈕或者關(guān)鍵名詞等。
以上是我隨手找的三個(gè)操作文檔的案例，總體上來(lái)看，似乎代表著「三大流派」。
優(yōu)點(diǎn)是統(tǒng)一性很強(qiáng)，都凸顯了專有的名詞和信息；
缺點(diǎn)是統(tǒng)一性太強(qiáng)了，導(dǎo)致分不清代表的分別是什么（是可以接受的缺點(diǎn)）。例如蘋果官網(wǎng)的那張圖“設(shè)置”>“蜂窩網(wǎng)絡(luò)”>“蜂窩數(shù)據(jù)選項(xiàng)”，其中「設(shè)置」是代表一個(gè)App，而「蜂窩網(wǎng)絡(luò)」和「蜂窩數(shù)據(jù)選項(xiàng)」是一個(gè)菜單選項(xiàng)。對(duì)于一些不熟悉的用戶來(lái)說(shuō)，第一印象可能會(huì)不太好區(qū)分「設(shè)置」到底是指什么？當(dāng)然這是我吹毛求疵的看法，我本人還是很認(rèn)可蘋果的這種做法的。
4. 我總結(jié)的特殊標(biāo)點(diǎn)符號(hào)的規(guī)范
頁(yè)面
當(dāng)描述的內(nèi)容包含某個(gè)菜單頁(yè)面的時(shí)候，建議使用「」或者“”，后面增加名詞修飾。
?
如需要完成某功能，請(qǐng)打開OMS的「訂單管理」頁(yè)面…… 如需要完成某功能，請(qǐng)打開OMS的“訂單管理”頁(yè)面……
Tab欄或狀態(tài)
當(dāng)描述的內(nèi)容包含了某個(gè)頁(yè)面下的Tab信息或狀態(tài)的時(shí)候，建議使用「」或者“”，后面增加名詞修飾。
?
若要查詢預(yù)報(bào)失敗的訂單，請(qǐng)打開OMS的「訂單管理」頁(yè)面，切換到「暫存」Tab狀態(tài)下，即可查看相應(yīng)的訂單…… 若要查詢預(yù)報(bào)失敗的訂單，請(qǐng)打開OMS的“訂單管理”頁(yè)面，切換到“暫存”Tab狀態(tài)下，即可查看相應(yīng)的訂單……
字段或者行內(nèi)代碼
當(dāng)描述的內(nèi)容包含某個(gè)新增的字段的時(shí)候，建議使用 反引號(hào)（`code`）來(lái)表示。
?
本接口需要新增一個(gè)字段 效期信息，用來(lái)展示具體SKU的效期信息，以便于客戶可以查詢到相應(yīng)的數(shù)據(jù)……
按鈕或者功能
當(dāng)描述的內(nèi)容中需要點(diǎn)擊某個(gè)按鈕或者使用某個(gè)功能的時(shí)候，建議使用【】來(lái)表示，不建議使用「」是怕直角引號(hào)太多，代表的含義太雜引起閱讀負(fù)擔(dān)。
?
當(dāng)訂單復(fù)核完成之后，需要點(diǎn)擊按鈕【錄入裝箱信息】，按實(shí)際裝箱的情況如實(shí)填寫……
組合示例
當(dāng)一段描述中包含上述所有關(guān)鍵詞時(shí)，甚至還有一些特殊的情況時(shí)，可以靈活變動(dòng)，使用括號(hào)()，直角引號(hào)「」或彎角引號(hào)“”（但是不建議同時(shí)出現(xiàn)直角和彎角引號(hào)），或者使用加粗，下劃線，文字顏色，背景顏色等。
?
先打開WMS的「訂單攔截與取消」頁(yè)面，然后進(jìn)入“待處理”狀態(tài)下，找到相應(yīng)的訂單。點(diǎn)擊【確認(rèn)并下發(fā)】，數(shù)據(jù)就會(huì)傳遞到PDA中，當(dāng)返庫(kù)上架完成了之后，就會(huì)將狀態(tài)變更為「已取消」。所以需要增加一個(gè)字段 處理類型，用來(lái)區(qū)分是系統(tǒng)自動(dòng)觸發(fā)了取消，還是正常的攔截返庫(kù)而取消……
5. 總結(jié)
上面總結(jié)的一些規(guī)范，僅適用于某些很小眾的場(chǎng)景下，大多數(shù)情況下只需要遵守標(biāo)點(diǎn)符號(hào)的標(biāo)準(zhǔn)規(guī)則即可。若按標(biāo)準(zhǔn)規(guī)則來(lái)判定，里面的一些符號(hào)用的也不是很標(biāo)準(zhǔn)。但是苦于這一塊的信息太少了，可交流的機(jī)會(huì)并不多，所以我只能先摸索著前行，后續(xù)再看實(shí)際情況而迭代更新了。
上述內(nèi)容都是基于Markdown的編輯形式，如果是使用富文本的方式，那么有一些樣式或者符號(hào)可能不支持。對(duì)于產(chǎn)品經(jīng)理來(lái)說(shuō)，我建議無(wú)論是需求文檔還是操作手冊(cè)，還是一些日常的經(jīng)驗(yàn)沉淀積累，都用Markdown來(lái)寫。
至于原因是什么？自己查一下，體驗(yàn)一下就會(huì)知道了。
如果你有更好的規(guī)范或者見解，歡迎與我私聊交流，因?yàn)檫@一塊的疑惑已經(jīng)困擾我很久了，我也想聽聽各位大佬的意見。
6. 參考資料
《少數(shù)派寫作排版指南》
https://sspai.com/post/37815
《別再用「六個(gè)點(diǎn)」當(dāng)省略號(hào)了，這些標(biāo)點(diǎn)都有更規(guī)范的輸入方式》
https://sspai.com/post/45516
《設(shè)計(jì)師與標(biāo)點(diǎn)符號(hào)》
https://www.bilibili.com/video/BV1AX4y1u7Ag
