產品文檔中,特殊標點符號的使用建議

2021-12-21 智享

本文作者:叫我vitamin

本文來源:皮醬叨逼叨(pijiangdbd)

---BEGIN---

1. 前言

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

剛好今天無意中刷到《少數派》的一篇文章,於是就趁此機會來談談我對產品文檔的一些特殊標點符號的理解和看法。

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

我對標點符號的用法鑽研的不是很深,所以此篇文章只是我個人經驗分享之談,並非金科玉律、標準方案,請大家辯證性對待。

2. 標點符號的標準規範

國家對標點符號的使用是有一套專門的標準規範的,感興趣的可以去看看:

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

其實大多數人都不是專業的編輯或者文字工作者,所以對標點符號的使用基本上不會過於嚴謹,只要能斷句、表達清楚意思即可。尤其是現在網際網路時代,文字表達的場合越來越多,很多行文方式都傾向於口語化,多元化和個性化(表情包和emoji等)。

所以國家標準更多的是適用於正規場合,而日常的工作交流等其實還是沒有那麼強的約束性的。所以如果大家看到了這篇文章中有很多地方使用的標點符號是不標準的,也不用急著跳出來批判我,畢竟這並非是一篇嚴謹的學術研究論文,請大家寬容一些看待。

本文想表達的是一些我在日常寫作時,發現的文檔排版和特殊的標點符號使用的一些困惑,以及我的解決方案。

標準的標點符號使用規範可以看上方的連結,這裡就不再過多的討論了。

3. 日常寫作中,我的幾點困惑1. 直角引號和彎引號

「」和「」之爭由來已久,最早的大規模爭論應該是發生在2012年左右的知乎上。直角派和彎角派爭論了很久還是無法統一,但是越來越多的社區開始學習知乎的方式,使用直角引號來替代彎引號了。

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

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

很多文檔是需要協作性工作的,如果我習慣性使用「」,而有一些同事習慣使用「」,那麼這樣協作出來的文檔肯定會不太美觀。

2. 中英文混排的問題

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

如果全文是以中文為基調的,那麼應該以全形標點符號為主體。

在Github上也有相關的指北,具體可以看下方的連結:

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


中英文混排-空格

很多程式設計師、產品經理可能都聽說過中英文混排加空格的規則,但是講實話對於經常要寫文章的人來說,加空格其實比較麻煩,會對寫作的流暢性有所影響。而且這個能遵守這個規範的人還是少數,這樣就會導致在協作的時候,有些人辛辛苦苦加空格;有些人一路寫到底,壓根不加空格。

難以統一行文風格,一直是團隊文檔協作的難題之一。 尤其是本職工作已經很多的情況下,如果還要對標點符號吹毛求疵,很容易被團隊小夥伴「圍毆致死」。

所以我選擇尊重團隊中大多數人的習慣,中英文混排時不加空格,但這也許在另外一個團隊中就是不被認可的了。

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

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

語雀的官方手冊

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

蘋果官網的手冊

蘋果使用「」來標記相關的App、頁面、操作、按鈕或者關鍵名詞等。

菜鳥WMS的手冊

菜鳥使用【】來標記相關的操作、按鈕或者關鍵名詞等。

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

優點是統一性很強,都凸顯了專有的名詞和信息;

缺點是統一性太強了,導致分不清代表的分別是什麼(是可以接受的缺點)。例如蘋果官網的那張圖「設置」>「蜂窩網絡」>「蜂窩數據選項」,其中「設置」是代表一個App,而「蜂窩網絡」和「蜂窩數據選項」是一個菜單選項。對於一些不熟悉的用戶來說,第一印象可能會不太好區分「設置」到底是指什麼?當然這是我吹毛求疵的看法,我本人還是很認可蘋果的這種做法的。

4. 我總結的特殊標點符號的規範頁面

當描述的內容包含某個菜單頁面的時候,建議使用「」或者「」,後面增加名詞修飾。

Tab欄或狀態

當描述的內容包含了某個頁面下的Tab信息或狀態的時候,建議使用「」或者「」,後面增加名詞修飾。

欄位或者行內代碼

當描述的內容包含某個新增的欄位的時候,建議使用 反引號(`code`)來表示。

按鈕或者功能

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

組合示例

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

5. 總結

上面總結的一些規範,僅適用於某些很小眾的場景下,大多數情況下只需要遵守標點符號的標準規則即可。若按標準規則來判定,裡面的一些符號用的也不是很標準。但是苦於這一塊的信息太少了,可交流的機會並不多,所以我只能先摸索著前行,後續再看實際情況而迭代更新了。

上述內容都是基於Markdown的編輯形式,如果是使用富文本的方式,那麼有一些樣式或者符號可能不支持。對於產品經理來說,我建議無論是需求文檔還是操作手冊,還是一些日常的經驗沉澱積累,都用Markdown來寫。

至於原因是什麼?自己查一下,體驗一下就會知道了。

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

6. 參考資料

《少數派寫作排版指南》

《別再用「六個點」當省略號了,這些標點都有更規範的輸入方式》

《設計師與標點符號》

相關焦點

  • 公文中幾個特殊標點符號的正確使用
    標點符號是幫助文字記錄語言的一套符號,在數理化等自然科學中,遇到公式時,如果這個公式可以用語言讀出來,我們就可以按照《標點符號用法》的規定使用標點符號,不同的是常常選用小圓點的句號。例如:    在表格中,如果只有數字、單詞,末尾不用標點;如果有句子,就應該和一般文句一樣使用標點。
  • 如何正切使用標點符號
    語文中標點符號是構成句子的一大重要部分。有好標點符號,不出現令人發笑的錯誤,則顯得尤其重要。標點符號該如何使用,又該注意哪些方面呢?句號逗號:句號用以結束意思相同的一個簡單句。當意思不同時使用句號阻隔。逗號:逗號在句中使用,用作短暫的停頓停頓時間比頓號長,比句號短。
  • 網絡文本表達中標點符號的運用
    具體到網絡文學,文本意思即人物、環境和情節共同呈現出的故事,文本表達則是承載故事的文字、符號和段落等。在傳統的文學表達中,作者斟酌的重點一般在遣詞造句上,但在網絡文學中,「花式」標點的運用為文本表達帶來了更多可能性。
  • 「薦讀」公文中幾個特殊標點符號的正確使用 - 河北共產黨員
    標點符號是幫助文字記錄語言的一套符號,在數理化等自然科學中,遇到公式時,如果這個公式可以用語言讀出來,我們就可以按照《標點符號用法》的規定使用標點符號,不同的是常常選用小圓點的句號。例如:如果A>B,B>C,那麼A>C.
  • 國家標準《標點符號用法》使用解析
    光明日報特邀該國家標準修訂課題組首席專家瀋陽教授和蘇培成、杜永道兩位語言專家,對《標點符號用法》的修訂和使用舉例做些說明。  後兩句中使用了括號、分號、引號、嘆號等,巧妙地將這首唐詩斷成了宋詞和電影中的背景和人物動作等特寫鏡頭。可見這小小的標點真可謂「小卒過河也能頂大車」!  標點符號並非能隨意使用,而是有自己的規範用法。目前我國實施的《標點符號用法》(簡稱新標準)是2011年12月國家質檢總局和國家標準委正式發布的。
  • 語言文字中標點符號的正確使用
    語言文字中離不開標點符號,常用的標點符號有16種,可以分為點號和標號兩大類。點號主要表明語句的停頓和說話的語氣。標號主要表明語句的性質和作用。如何正確使用標點符號,應注意以下幾個方面:一、標點符號的書寫位置要正確,雖然在考試中不在設這樣的考題,但是在書寫中卻有要求,標點符號在書寫時要佔格寫。二、標點符號的正確使用。1、句號、問號、感嘆號是用在句子的末尾表示句子的語氣。2、逗號、頓號和分號用在句子的中間表示句子的停頓。
  • 正確使用標點符號
    考綱要求:語文科《考試說明》對「正確使用標點符號」這一考點的說明是:「標點符號的運用要求熟悉各類標號和點號的規範用法和規範書寫,根據語意正確使用標點符號。」能力層級為D級(表達應用)。⑹下列各句中標點符號使用正確的一項是(  )A.觀眾長時間的等待,只為一睹他的風採、或請他籤上一個名。B.每個人都有他自己的愛好,你看我女兒,長這麼大了,還那麼喜歡那些小玩藝,什麼小泥人呀、小布熊呀、小瓷缸呀,擺滿房間。
  • 語文總複習:標點符號的使用,小學初中必須掌握的基礎!
    標點符號是漢語言中相當重要的一個部分。一個小小的標點符號的改變有時甚至會影響到整個語句的意思。因此,標點符號的用法要好好掌握。我們在小學的學習中,也會接觸和學習一些簡單的基礎的標點符號,到了初中之後,標點符號的學習就會比較複雜和多變一點,標點符號也是每次考試必考的題型之一。
  • 標點不能小視,作文中標點符號的使用規範
    今天這一講我們來講一下作文中的標點的使用,標點雖小但是作用不小,標點的錯誤同樣不可忽視。通過這一講,我們將作文中標點符號常見的問題進行整理,幫助同學們有效地避免標點上的錯誤。我們這講的主要內容就是標點使用的規範性。
  • 博士媽媽:小學生標點符號使用大全,建議家長收藏
    一篇好的作文,除了新穎的構思、優美的詞語,標點符號的靈活運用也在優質作文的範疇當中,部分孩子在寫作文時,標點符號除了逗號就是句號,沒有其他標點,寫作文像是記流水帳,就像是一條路「一通到底」沒有「轉彎」更沒有「上下坡」。
  • 百度百科如何使用規範的標點符號
    百度百科中應使用全形標點符號。  例如:在<<莊子.雜篇.天下>>中,莊子寫道:" 一尺之捶,日取其半,萬世不竭."  修正:在《莊子·雜篇·天下》中,莊子寫道:「一尺之捶,日取其半,萬世不竭。」  請儘量使用常用的標點符號,避免使用【】『』等符號。
  • 英語論文中標點符號的使用規範
    表示說話中的猶豫或遲疑。如:「If that the way you think...just go back to school ,」he said.表示段落或整行詞句的省略, 須使用一整行黑點。斜體是英語的一種獨特的書寫手段, 但具有標點的作用, 在手寫稿和列印稿中,字下線和印刷品中的斜體字功用相同。斜體和字底線的作用完全一樣。
  • 特殊情況下的標點符號的用法
    標點符號是輔助文字記錄語言的符號,是書面語的有機組成部分。正確使用標點符號,不僅有助於表明詞語的性質與作用、準確地表情達意,也有助於漢語言的規範。今天給大家分享幾則複雜情況下的標點符號用法,來看看你都能準確掌握嗎?「F·卡普拉」宜寫成「F.卡普拉」某書稿中說:「其作者F·卡普拉說……」。
  • 標點符號會說話,如何引導孩子們在作文中規範地使用標點符號?
    上例中的標點符號如此重要,可是我卻發現,在孩子們平時的作文中,有許多不重視標點符號的現象:他們有的不用標點符號,有的僅僅用了逗號和句號,有的即便運用了標點符號,書寫格式也不對…… 我曾接手過一個班級,不規範運用標點符號的現象很普遍,特別是一名叫小豪的男生,寫了一篇作文,不光篇幅不長,而且看起來就像沒有斷句的古文一樣,竟然連一個標點符號都沒有用,這讓我大吃一驚
  • 如何在Word中使用特殊字符和符號
    您可能要在Microsoft Word文檔中鍵入的某些符號和特殊字符沒有出現在鍵盤上,但是您仍然可以通過單擊幾下將它們包括在文檔中。如果您經常使用這些特殊字符,甚至可以將它們分配給快捷鍵,以使其更加容易使用。
  • 英語中標點符號、斜體等的使用(詳解版)
    中英文標點符號的差異 漢語中目前使用的標點符號是參考借鑑西文的標點體系而制定的,它既保留了西文標點的主體特徵,又帶有與漢語語言特點相適應的特色。因而,中英文標點符號之間存在著一定的差異。 ⒈ 漢語中的某些標點符號為英語所沒有。
  • 公文中標點符號用法
    一、標題中標點符號的用法 公文的標題,即一級標題的末尾,一般不加標點符號。
  • 行測邏輯填空「特殊」標點符號盤點!
    說起邏輯填空中特殊的標點符號,大家可能都會想到逗號、頓號等等。
  • 低年級標點符號正確使用的順口溜
    ,每一句話都需要用一個標點符號。可見標點符號在語文學習中是多麼重要。特別是一、二年級的孩子已經認識了逗號、句號、問號和感嘆號,可是這些標點符號他們不會使用,個別孩子都是亂用標點符號或者錯用標點符號。本期快樂魔方作文就為大家講解標點符號的如何使用,希望能幫助到大家!
  • 為什麼我們熱衷於使用一連串或組合式的標點符號???
    表示無語,又或是用浪紋線「~」表達歡快或委婉的語氣,也有很多網友習慣了在聊天時不加任何標點符號。這些使用習慣與其書面用法大相逕庭,但在如今又十分常見,可以說是標點符號的一種異化現象。標點符號的異化指的是與規範用法不同的標點符號用法,其衍生出了新的形式和新的意涵。