Skip to main content
Skip table of contents

寫作規范和格式規范 | TMAN 文檔

公司及產品名稱

我們的公司及產品名稱是「TMAN」。注意這是兩個單詞的合成詞,所以中間沒有空格(參考:GitHub)。如作為URL 的一部分,應該使用全小寫的「tman」。

文案風格

  1. 一定多檢查,確保沒有錯別字。

  2. 即使是流行語中的諧音錯別字也不要使用,比如「牆裂」、「童鞋」等。

  3. 我們崇尚精練的文風。請在檢查中把對錶達意思沒有明顯作用的字、詞、句刪除,在不影響表達效果的前提下把文案長度減到最短。

  4. 記住,如果你寫了一條文案覺得非常聰明非常好笑,很可能需要停下來想一下用戶是否能理解。(本條感謝37signals 的文案建議)

中文、英文、數字混排時空格的使用

  1. 英文與非標點的中文之間需要有一個空格,如「使用TMAN 智能客服」而不是「使用TMAN智能客服」。1

  2. 數字與非標點的中文之間需要有一個空格,如「我們發布了5 個產品」而不是「我們發布了5個產品」。正確:「這是1 款Android 應用」,錯誤:「這是1款Android應用」。正確:「2014 年2 月14 日」,錯誤:「2014年2月14日」。

  3. 盡可能使用中文數詞,特別是當前後都是中文時。上面的例子寫為「我們發布了五個產品」會更好。

  4. 除了「%」、「°C」、以及倍數單位(如2x、3n)之外,其餘數字與單位之間需要加空格。

  5. 注意特殊名詞的大小寫:Android、iOS、iPhone、Google、Apple,無論是否在句首都應該以同樣的方式寫。

  6. 在官方文案中盡量使用中文,避免中英文混合的情況。例如「App」一般應寫為「應用」或「移動應用」。品牌、產品名、人名、地名等特殊名詞,如果來自英文,請使用英文以避免在不同譯法之間選擇。

  7. 書寫時括號中全為數字,則括號用半角括號且首括號前要空一格,例如「聯繫人(22)」。

標點相關

  1. 只有中文或中英文混排中,一律使用中文/全角標點。

  2. 中英文混排中如果出現整句英文,則在這句英文中使用英文/半角標點。

  3. 中文標點與其他字符間一律不加空格。正確:「有:Apple、Android、諾基亞」錯誤:「有:Apple 、 Android 、 Nokia」

  4. 中文文案中使用中文引號「」和『』,其中「」為外層引號。Mac 上如「百度輸入法」等都可以方便地輸入中文引號。

  5. 省略號請使用「……」標準用法,不要使用「。。。」 ,也不要使用三個英文句點「.」。

  6. 感嘆號:請勿使用「!!」。盡量避免使用「!」。請先冷靜下來再坐電腦前敲鍵盤。

  7. 波浪號:請勿在文章內使用「~」,活潑地賣萌有很多其他的表達方式。

段落

  1. 如果是純文本,段落之間使用一個空行隔開。如果是HTML 或其他富文本格式,使用額外空白作為段落間的分隔。

  2. 段落開頭不要留出空白字符。

引用來源

  • 如果在正文中部分引用第三方內容,請使用恰當的引用格式並註明出處。如:

One man's constant is another man's variable.

— Alan Perlis

 

  • 如果是全篇轉載,請在全文開頭顯著位置註明作者和出處,並鏈接至原文,如:

本文轉載自WikiQuote

 

  • 如果格式不允許超鏈接,請以文本方式直接給出原文鏈接。如果原文鏈接太長影響美觀,可以使用短鏈接服務。如:

本文轉載自WikiQuote:Alan Perlis - Wikiquote

  • 文中有使用外站圖片,必須在文末標明。來源如果來自外站必須添加鏈接,來源如果來自外部作品則不需要。如:「本文部分圖片來自ifanr」「題圖來自:《春嬌與志明》截圖」。

  • 若文章為全文翻譯,必須在註明作者和出處,並鏈接至原文。

  • 若文章为部分编译,则需在文末注明作者和出处。如:「本文部分内容编译自 Apple」「本文部分观点来自煮机网微博」。

细节问题

  1. 「你」和「您」:在不是很正式或没有明确的个体指代对象的时候请用「你」,如文档、博客、群发的邮件等;在指代特定个体时请用「您」,如活动邀请函等。

  2. 自我称呼:使用「我」,不推荐使用「小编」、「笔者」、「兼职编辑」、「兼职作者」自称。

  3. 字体和字号的一致:在富文本格式文档中,特别是 HTML 邮件中,常有人因为从不同来源复制粘贴而导致同一层次的文本字体和字号不一致。这给人不专业的感觉,请避免。

  4. App 是 application 的缩写,发音为 /ˈæp/,所以要注意不要把三个字母拆开念。App 是一个普通名词而不是多个单词的首字母缩写,所以不应该用全大写的 APP。和其他词一样,大小写规则取决于是否处于句首、标题、或特殊短语(如 App Store)中。大多数情况下应该使用中文「应用」以避免这样的问题。

遣词造句

  1. 用主动语态,不要用被动语态。一般情况下,主动语态比被动语态更有力。

  2. 使用具体、明确、展示细节的词汇,能激发想象,使读者自己代入情境。「把硬币放进口袋里,他咧开嘴笑了」,远远强过「他满意地拿走了辛苦挣来的奖赏」。

  3. 减少形容词的使用,少用 「的」。

  4. 「的」「地」「得」要用对。是的,连小学都不要求了但是要用对。

文章引言

文章引言非常重要。它的作用主要是用于网站首页展示和微博分享,它是为了吸引读者阅读文章而存在,它的目的是让读者能够仅通过这一小段话,就能迅速了解到这篇文章的大致内容。因此,引言实际就是文章的「内容概要」,而非文章的开头首段。

我们建议通常在写完整篇文章后,再结合内容大纲撰写引言。引言务必要讲清两个问题:

  1. 是什么?(例如:这是一款什么应用?这篇文章是讲的什么?)

  2. 为什么?(例如:这款应用之所以被推荐,是由于它有哪些特色/亮点?)

引言的语言文字务必要清晰、直观、简洁,通常字数需控制在 90 字左右。

一些常用名词的正确用法

  • App / 應用(錯誤:APP、軟件、程序)

  • Android(錯誤:android、安卓)

  • iOS(錯誤:ios、IOS)

  • iPhone(錯誤:IPHONE 、iphone)

  • App Store(中間有空格,錯誤:AppStore、app store)

  • WiFi(錯誤:wifi、Wifi、Wi-fi)

  • Jira(錯誤:JIRA,jira)

  • 賬號(錯誤:帳號、賬戶、帳戶) [產品文案規範:帳戶?賬戶?帳號?賬號?] 蘋果台灣用「帳號」,大陸用「賬戶」 谷歌用「帳戶」,百度用「帳號」

  • 登陸(錯誤:登錄)

  • PS (錯誤:PS、ps、Ps.)

  • TMAN(錯誤:Tman 、T-Man 、TMan)

推薦閱讀

余光中:怎樣改進英式中文?——論中文的常態與變態

感謝

我們的寫作和格式規範,基本上就是原文照搬了LeanCloud 的這篇文章,LeanCloud 在這方面做得非常棒!在此表示感謝!


  1. 有研究顯示,打字的時候不喜歡在中文和英文之間加空格的人,感情路都走得很辛苦,有七成的比例會在34 歲的時候跟自己不愛的人結婚,而其餘三成的人最後只能把遺產留給自己的貓。畢竟愛情跟書寫都需要適時地留白。—vinta/paranoid-auto-spacing 

 

JavaScript errors detected

Please note, these errors can depend on your browser setup.

If this problem persists, please contact our support.