0%

文案风格及排版指南

essay

评价一个科技媒体或者设计师是否专业,我会看中英文之间是否空一格,因为美好的文字值得用更优雅的方式呈现。

国外的一些科技公司(AppleGoogleMicrosoft……)和国内的一些科技媒体(少数派好奇心日报Readhub……),在中英文混排时,会在全形字(中文)和半形字(英文、数字、符号等)之间添加一个半角空格,以增加视觉美感。

大概在 2018 年 1 月份,微信也悄悄地跟进了这种排版美学。例如,你在微信聊天框输入 庭说TingTalk 并发送,会自动变成 庭说 TingTalk

拼写正确

尊重专有名词的正确写法,是写作 / 排版的第一步:

✔️
App、app APP
App Store Appstore
a.m. am、AM、A.M.(上午)
email E-mail、Email
GitHub Github、github
Google google
iOS IOS
iPhone XS Max Iphone xs MAX
macOS MacOS
kg KG、Kg
km Km、KM
Markdown MarkDown
OK ok
P.S. PS、ps、Ps.
Siri siri
WeChat Wechat、wechat
WhatsApp Whatsapp、whatsapp
Wi-Fi WIFI、WiFi、wifi
YouTube Youtube
4K 4k
1080p 1080P
登录 登陆
账号 帐号、账户、帐户

英文拼写错误

❗ ️大写有突出强调的作用,意味着这个单词或者句子很重要。

句首字母大写

  • ❌ how are you?
  • ✔️ How are you?

专有名词大写

  • ❌ Happy mid-autumn festival
  • ✔️ Happy Mid-Autumn Festival(连字符用最短的 hyphen -

I(我)在任何时候都大写

  • ❌ I am a slow walker, but i never walk back.
  • ✔️ I am a slow walker, but I never walk back.
  • 📝 我走得很慢,但是我从来不会后退。by 亚伯拉罕·林肯(Abraham Lincoln)

internet 首字母不再大写

  • 一开始的 Internet 首字母是大写(特殊的专有名词),随着互联网的普及,它不再特殊,所以被降级成 internet。

App

  • App 念作 [æp] ,而非 A-P-P(爱啪啪)。
  • 当用于标题或首字母时,写作「App」,当用于正文泛指时写作「app」。
  • App 的复数形式是「apps」。

符号拼写错误

罗马数字

  • ✔️ I、Ⅱ、Ⅲ(它们是一个整体)
  • ❌ I、II、III(用一个或多个大写字母 I 代替)

乘号

  • ✔️ ×(微软拼音输入 cheng 即可弹出正宗的乘号)
  • ❌ 字母 x 或 X 代替

借助搜索引擎、官方网站和维基百科,你不难找到专有名词应该怎么写。

多空一格

行文时,请务必在全角字符(汉字)和半角字符(字母、数字或符号)之间空一格(半角空格)。混排时,通过刻意增加空格的方式,会让段落看起来不那么「拥挤」,增加中英混排的美感。

中文与英文之间增加空格

  • ✔️ 通过 Google 搜索引擎,你可以更快地找到想要的信息。
  • ❌ 通过Google搜索引擎,你可以更快地找到想要的信息。
  • 📝 「豆瓣FM」等专有产品名词,按照官方所定义的格式书写。

中文与数字之间增加空格

  • ✔️ 2016 年 4 月 29 日,公众号「庭说」发出第 1 篇文章。
  • ❌ 2016年4月29日,公众号「庭说」发出第1篇文章。

中文与链接之间增加空格

  • ✔️ 庭说的 博客 于 2017 年 7 月 18 日正式运营。
  • ❌ 庭说的博客于 2017 年 7 月 18 日正式运营。

数字与单位之间增加空格

  • ✔️ iPhone XS 显示屏的像素密度是 458 ppi,最大亮度(标准)是 625 cd/m²。
  • ❌ iPhone XS 显示屏的像素密度是 458ppi,最大亮度(标准)是 625cd/m²。
  • 📝 我的手机可用储存空间只剩 1GB 了。(在 Apple 的排版哲学中,这是个特例。是否要空一格,看你的个人选择。)

标点符号

长文本中穿插的符号就像湖面上泛起的波澜、绸缎上镶嵌的装饰,为版面带来节奏和纹理。对我来说,这一个理由便足够了——美本身就是值得追求的。by PlatyHsu

中文标点符号必须使用全角字符。排版时,它们占用的宽度等于一个中文字符,例如 ;而英文一般使用半角标点符号。排版时,它们占用的宽度等于半个中文字符,例如 .

  • ✔️ 三毛说:「心若没有栖息的地方,到哪里都是在流浪。」
  • ❌ 三毛说:「心若没有栖息的地方,到哪里都是在流浪. 」
  • ✔️ 请确认所有的连接(电缆和接插件)均安装牢固。
  • ❌ 请确认所有的连接(电缆和接插件)均安装牢固。
  • 📝 请确认所有的连接 (电缆和接插件) 均安装牢固 (Apple 的做法:半角括号 + 前后空格)。

完整的英文句子,用半角标点符号

  • ✔️ 乔布斯说过:「Stay hungry, stay foolish.」
  • ❌ 乔布斯说过:「Stay hungry,stay foolish。」

中文符号

感叹号

不到万不得已,坚决不用感叹号。平和地表达,才能发出理性的声音。

  • ✔️ 心平气和地表达自己的看法,尽量避免使用感叹号!
  • ❌ 心平气和地表达自己的看法,尽量避免使用感叹号!!!(不要重复使用标点符号)
  • 📝 当句子包含疑问、感叹两种语气都比较强烈时(如带有强烈感情的反问句和带有惊愕语气的疑问句),可在问号后再加叹号,例如「这点困难就能把我们吓倒吗?!」

省略号 ……

如何输入:

  • ✔️ 切换到中文输入法, Shift + 6(在主键盘的字母 T 上方)即可输入正确的省略号 ……
  • ❌ 多个中文句号代替 。。。 或多个英文句点代替 ......

省略号不应与「等」这个词一起使用:

  • ❌ 我们为会餐准备了香蕉、苹果、梨…等各色水果。
  • ✔️ 我们为会餐准备了各色水果,有香蕉、苹果、梨……
  • ✔️ 我们为会餐准备了香蕉、苹果、梨等各色水果。

逗号

  • 逗号表示句子内部的一般性停顿。
  • 注意避免「一逗到底」,即整个段落除了结尾,全部停顿都使用逗号。

顿号

并列形容词之间用顿号:

  • ✔️ 这里有自由、民主、平等、开放的风气和氛围。
  • ❌ 这里有自由,民主,平等,开放的风气和氛围。

最后一项内容前已经用了「及」、「以及」、「和」等字样,则最后一项前不再使用顿号:

  • ✔️ 警方还组织数千民兵专门看护桥梁、过街天桥、涵洞和道口等重点部位。
  • ❌ 警方还组织数千民兵专门看护桥梁、过街天桥、涵洞、和道口等重点部位。

不能用 代替顿号

  • ✔️ 警方还组织数千民兵专门看护桥梁、过街天桥、涵洞等重点部位。
  • ❌ 警方还组织数千民兵专门看护桥梁,过街天桥,涵洞等重点部位。

如果并列的是短句,应使用逗号:

  • ✔️ 我问了他很多问题,三年前在干什么,两年前在干什么,今后打算干什么……
  • ❌ 我问了他很多问题、三年前在干什么、两年前在干什么、今后打算干什么……

标有引号的并列成分之间、标有书名号的并列成分之间通常不用顿号。若有其他成分插在并列的引号之间或并列的书名号之间(如引语或书名号之后还有括注),宜用顿号:

  • ✔️ ️️「日」「月」构成「明」字。
  • ✔️ 店里挂着「顾客就是上帝」「质量就是生命」等横幅。
  • ✔️ 《红楼梦》《三国演义》《西游记》《水浒传》是我国长篇小说的四大名著
  • ✔️ 李白的「白发三千长」(《秋浦歌》)、「朝如青丝暮成雪」(《将进酒》)都是脍炙人口的诗句。

括号 ( )

中文夹用英文注释,用中文全角圆括号标示注释:

  • ✔️ The Beatles(1968)有一首歌,题为《除了我和我的猴子人人都想捂藏一点东西》(Everybody's Got Something to Hide except Me and My Monkey),这首歌后来音乐家称之为《猴子》。
  • ❌ The Beatles(1968)有一首歌,题为《除了我和我的猴子人人都想捂藏一点东西》(Everybody's Got Something to Hide except Me and My Monkey),这首歌后来音乐家称之为《猴子》。

句子末尾用括号加注时,句号应在括号之外:

  • ✔️ 关于文件的输出,请参照第 1.3 节(见第 26 页)。
  • ❌ 关于文件的输出,请参照第 1.3 节(见第 26 页。)

英文符号

使用英文(半角)标点符号

  • ❌ I’m Tim。(使用中文全角标点符号)
  • ✔️ I'm Tim.

标点符号后面空一格

  • ❌ Mr.Zhong
  • ✔️ Mr.Zhong
  • ❌ We need seven people:three students,three engineers,and a professor.
  • ✔️ We need seven people: three students,three engineers,and a professor. (注意 and 前面有一个逗号)

每句话与上一句的标点之间一定要有空格。空格是分隔单词用的,如果前后两句话之间没有空格,那么上一句的最后一个词,和下一句的第一个词,就连在一起了。比如「I_am_here._It_is_8:00_now.」 如果写成「I am here.It is 8:00 now.」,那么「here.it」这样是不规范的,只有同一个词中才会出现这样的写法,比如「a.m.」、「U.S.A.」,中间没有空格,看做是一个词。上边的「here.it」甚至可能被一些网站当成是链接网址,因为「.it」是一个域名,网址中间是不加空格的。

如果英文与中文同时存在,英文单词和中文之间应该加一个半角空格。比如「今天 CNN 的报道我看了。」「There_is_a_木_in_the_Chinese_character_树.」等等。

成对符号(括号和引号)前后空一格

  • ❌ The screen is 6.46 inches(iPhone XS Max)diagonally.
  • ✔️ The screen is 6.46 inches(iPhone XS Max)diagonally.
  • ❌ He said,"I may forget your name,but I never forget a face."
  • ✔️ He said,"I may forget your name, but I never forget a face."

在某些 Style Guide 中(例如 Apple),纵使在中文语境下,也会将(中文)全角括号替换为 (英文) 半角括号,并在括号外添加半角空格(两个连续的标点之间不添加空格):

iPhone SE 可防溅、抗水、防尘,在受控实验室条件下经测试,其效果在 IEC 60529 标准下达到 IP67 级别 (在最深 1 米的水下停留时间最长可达 30 分钟)。by Apple

斜杠 / 前后加空格

❗ 此法有争议,酌情采用。

  • ❌ HR/Vice President
  • ✔️ HR / Vice President

省略号

  • ❌ Juan thought and thought…and then thought some more.(省略号前后没有空格)
  • ❌ Juan thought and thought ... and then thought some more.(三个英文句号代替省略号)
  • ✔️ Juan thought and thought … and then thought some more. (省略号是一个整体,不可分割)

表示中文时,英文省略号()应改为中文省略号(……):

  • 英文: 5 minutes later⋯
  • 中文: 5 分钟过去了⋯⋯

⌨️ 如何输入省略号

  • Android(安卓手机):你肯定能找到它
  • iOS(苹果手机和苹果平板):长按英文键盘上的句号
  • macOS(苹果电脑):Option + ;(分号键)
  • Windows 电脑:
    • 方法一:Alt + 0133(按住 Alt,依次在右侧的小键盘上输入 0 1 3 3
    • 方法二:在中文输入状态下,按 Shift + 6(字母 T 上方的 ^),再删除一半,然后再切换回英文输入状态

小数点

不严谨地说,东方世界是万位计数法(1 2345 6789.10),而西方世界则是千位计数法(123 456 789.10)。不管是哪一种计数法,在数额巨大时,插入定界符(delimiter)可以方便读者辨识这串数字到底有多大。而在西文中,由于小数点符号(decimal separator 或 decimal mark)的使用习俗不同,会间接影响到千分位符号(也称千位分隔符,group separator)的选择,所以这些写法在不同国家会代表不同数值:12,34512.34512,345.67812.345,678

小数点用来分隔数字的整数部分与小数部分。如 3.14 中的 .,但地球是圆的:

  • 汉语地区和大多的英语地区:使用 . 句点(full stop)作为小数点
  • 大多的其他欧洲国家和其前殖民地:使用 , 逗号(comma)作为小数点
长串数字 千分位 小数点 常用于
125,124,024.25 , . 英美
125.124.024,25 . , 欧洲
125 124 024,25 , 国际单位制(逗号地区)
125 124 024.25 . 国际单位制(句点地区)

参考资料

表并列

中文:不要用逗号代替顿号

  • ❌ 警方还组织数千民兵专门看护桥梁,过街天桥,涵洞等重点部位。
  • ✔️ 警方还组织数千民兵专门看护桥梁、过街天桥、涵洞等重点部位。

英文:用逗号表示并列关系(不存在顿号)

  • ❌ We need seven people: three students、three engineers、and a professor.
  • ✔️ We need seven people: three students,three engineers,and a professor.

不存在的标点符号

顿号

没有顿号 ,用逗号 , 表并列:She slowly, carefully, and deliberately moved the box.

书名号

英文中没有书名号 《》,用斜体(Italic,意大利体)表示书名:

  • The title of Stephen R. Covey’s book is The 7 Habits of Highly Effective People.

英文书名或电影名改用中文表达时,双引号应改为书名号:

  • 英文: He published an article entitled "The Future of the Aviation".
  • 中文:他发表了一篇名为《航空业的未来》的文章。

其他符号

多空一格

运算符
  • ✔️ 20 ± 2%、p < 0.01、1 + 1 = 2
  • ❌ 20±2%、p<0.01、1+1=2
斜线 / 前后空一格
  • ✔️ 开 / 关
  • ❌ 开/关
版权标识 ©
  • ✔️ Copyright © 2019 TingTalk 保留所有权利。
  • ❌ Copyright©2019 TingTalk 保留所有权利。

不必空格

摄氏度符号与数字之间
  • ✔️ 科学家通过分析卫星数据发现地球的最低温出现在南极东部高原,达到零下 100℃。
  • ❌ 科学家通过分析卫星数据发现地球的最低温出现在南极东部高原,达到零下 100 ℃。
货币符号与数字之间
  • ✔️ 一碗原味猪肉汤饭只要 ¥10。
  • ❌ 一碗原味猪肉汤饭只要 ¥ 10。
百分号与数字之间
  • ✔️ 去年营业额增长 5%
  • ❌ 去年营业额增长 5 %
倍数与单位之间
  • ✔️ 2x、3n
  • ❌ 2 x、3 n

关联阅读

其他规范

时间

  • ✔️ 12:05(半角冒号)
  • ❌ 12:5(未补零)
  • ❌ 12:5(全角冒号)

日期

样式一

  • ✔️ 2018-09-07(推荐)
  • ✔️ 2018.09.07
  • ❌ 2018-9-7

样式二:

  • ✔️ 2018 年 9 月 7 日(简洁醒目)
  • ✔️ 二零一八年九月七日(庄重典雅)
  • ❌ 2018年09月07日

数字

农历月日

  • ✔️:腊月二十三、八月十五中秋节(选用汉字数字)
  • ❌:腊月23、8月15中秋节

阿拉伯数字与汉字数字同时使用

  • 如果一个数值很大,数值中的「万」和「亿」单位可以采用汉字数字,其余部分采用阿拉伯数字。例如:我国 1982 年人口普查人数为 10 亿零 817 万 5288 人
  • 除上面情况之外的一般数值,不能同时采用阿拉伯数字与汉字数字。例如:108 可以写作「一百零八」,但不应写作以「1 百零 8」「一百 08」;4000 可以写作「四千」,但不应写作「4 千」

参考资料

数值范围

表示区间时,保留两端的单位。

  • ✔️ 梨园乡种植的巨风葡萄今年已经进入了丰产期,亩产 1000 公斤至 1500 公斤。(或用
  • ⚠️ 梨园乡种植的巨风葡萄今年已经进入了丰产期,亩产 1000 公斤 ~ 1500 公斤。(浪纹号
  • ❌ 梨园乡种植的巨风葡萄今年已经进入了丰产期,亩产 1000 ~ 1500 公斤。(波浪号 ~
  • ✔️ 此事件有 5% 至 10% 的可能性发生。
  • ❌ 此事件有 5至10% 的可能性发生。
  • ✔️ 56 mm ± 2 mm、(56 ± 2)mm、(56 ± 1)%
  • ⚠️ 10 × 15 × 20 mm(特例)
  • ⚠️ 10 mm × 15 mm × 20 mm(过于冗余?存疑)

连接号

(全形)浪纹号(颚化符) 波浪号
~
U+FF5E FULLWIDTH TILDE U+007E TILDE
占一个汉字的位置 占半个汉字的位置
全角模式下,Shift + ~Esc 的下方) 半角模式下,Shift + ~Esc 的下方)

如何输入正确的浪纹号 来标示数值范围的起止?以微软拼音为例:

  1. 切换到全角状态(Shift + Space
  2. Shift + ~Esc 的下方)
  3. 切换回半角状态(Shift + Space),接着输入其他内容

因此,输入正确的浪纹号是一件很麻烦的事,推荐使用 或者 代替 :-20°C 至 -10°C。

有序列表

✔️ 在小数点后面空一格(参考 Markdown 的写法)
1. 静音
2. 关机
3. 睡觉

❌ 未在小数点后空一格
1.静音
2.关机
3.睡觉

---

✔️ 顿号后面不用空一格
1、静音
2、关机
3、睡觉


❌ 顿号后面空一格
1、 静音
2、 关机
3、 睡觉

电话号码

  • ✔️ 156 1024 1024(3-4-4 的格式,方便记忆和拨号)
  • ❌ 15610241024

首行顶格

  • 段落首行缩进 2 个字符是纸媒时代的旧习,文章的排版像狗啃了一样
  • 在数字时代(特别是在移动端)
    • 首行顶格
    • 段落之间用空行隔开

争议之处

以下用法略带有个人色彩,如有高见,欢迎与我(微信号:804 976 336)讨论。

项目列表句末不加分号或句号

✔️

  • 早上吃鸡蛋和水果
  • 中午吃蔬菜沙拉和鱼
  • 晚上吃番薯和一小碗饭
  • 睡前喝一瓶纯牛奶

  • 早上吃鸡蛋和水果;
  • 中午吃蔬菜沙拉和鱼;
  • 晚上吃番薯和一小碗饭;
  • 睡前喝一瓶纯牛奶。

📝(长句例外)

  • 人生第一境界:昨夜西风凋碧树。独上高楼,望尽天涯路。
  • 人生第二境界:衣带渐宽终不悔,为伊消得人憔悴。
  • 人生第三境界:众里寻他千百度。蓦然回首,那人却在,灯火阑珊处。

「直角引号」代替“蝌蚪”引号

理由

  • “蝌蚪”引号在数字世界容易渲染出错,是半角还是全角?是英文还是中文,飘忽不定。
  • 直角引号与方块字更契合。

输入

例外

  • 当引号表示讽刺、反语暗示时,使用弯引号:工作使我“快乐”。

Ta 们

  • 📝 虽然「他们」在表达上可以泛指男女,但在形式上给人单指男性的印象,所以我推荐使用「他(她)们 / ta 们 / Ta 们 / TA 们」泛指自己和对方以外的若干人(有男有女)
  • ✔️ 将来我们有了孩子,给他(她)取名字一定不能草率了。
  • ✔️ 将来我们有了孩子,给 Ta 取名字一定不能草率了。

其他 VS 其它

  • 其他:指人
  • 其它:指事件、物、地方等

少用斜体

西文中有两种形状倾斜的字体:Oblique type 和 Italic type,倾斜后字形也发生的变化的是「意大利体」(Italic Type),而单纯将原字体向右倾斜而没有形变的称为伪斜体(Oblique type)。中文(汉字)的斜体实际上都是单纯将字面从正方形改为平行四边形的“伪斜体”。传统排版中,汉字一般不使用斜体。电脑的普及给字体变形带来了极大方便,才将西文这一习惯延伸到中文。by 维基百科

少用++下划线++

下划线是打字机时代的产物。在当代,它作为 超链接(URL) 的标识,不作为强调。

风格指南

中文风格

多用主动语态

少使用被动语态。

  • ❌ 假如此软件尚未被安装……
  • ✔️ 假如尚未安装这个软件……
  • ❌ 他被选为议长。
  • ✔️ 他当选为议长。

多用肯定句

同样一个意思,尽量使用肯定句表达,不使用否定句表达。

  • ❌ 请确认没有接通装置的电源。
  • ✔️ 请确认装置的电源已关闭。

少用双重否定句

  • ❌ 没有删除权限的用户,不能删除此文件。
  • ✔️ 用户必须拥有删除权限,才能删除此文件。

少用复合句

尽量使用简单句和并列句:

  • ❌ 那个昨天生病的人没有参加会议。
  • ✔️ 他昨天生病了,没有参加会议。

精简句子

我们崇尚精练的文风。请在检查中把对表达意思没有明显作用的字、词、句删除,在不影响表达效果的前提下把文案长度减到最短。

  • 单个句子的长度尽量保持在 20 个字以内。
  • 20 个至 29 个字的句子,可以接受。
  • 30~39 个字的句子,语义必须明确,才能接受。
  • 多于 40 个字的句子,在任何情况下都不能接受。

例如:

  • ❌ 本产品适用于从由一台服务器进行动作控制的单一节点结构到由多台服务器进行动作控制的并行处理程序结构等多种体系结构。
  • ✔️ 本产品适用于多种体系结构。无论是由一台服务器(单一节点结构),还是由多台服务器(并行处理结构)进行动作控制,均可以使用本产品。

现在你看文件越来越厚,但里面包含的信息量越来越少。我们经常在我们开某一次会以后,出个什么文件,然后又组织好多人去辅导。按理说一般有文字阅读能力的人,有知识的人都应该能看明白,但事实上我们没有办法看明白,就因为这文件里包含着好多的词汇,它与它本身的含义是不一样的。by 张维迎 谈语言腐败(文字稿 | YouTube

用语正式

在我看来,好的文字应该是长命的,缓释的价值越多,文字越高级。高级的文字并不着力于哗众取宠的爆发,而是有与众不同的角度和观点。我们会本能的高估短期,而低估长期,文字的价值如是,生活工作也是。by 二爷(邱岳)

少用网络流行语或谐音词,比如「蓝瘦香菇」、「吃枣药丸」、「图样图森破」等,因为多年以后,晚辈可能无法领悟这些梗:

  • ❌ Lady Gaga 的演唱会真是酷毙了,从没看过这么给力的表演!!!
  • ✔️ 无法参加本次活动,我深感遗憾。

粉丝

  • 不要称呼喜欢我们的用户为「粉丝」,而是使用「用户」或「读者」。
  • 粉丝的说法显得不平等。而且很多人不喜欢这种称呼,因为它含有缺乏独立思考的意思。

你和您

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

不使用「温馨提示」一词。

形容词

不要使用过多的形容词。

  • ❌ 此设备的使用必须在接受过本公司举办的正式的设备培训的技师的指导下进行。
  • ✔️ 此设备必须在技师的指导下使用,且指导技师必须接受过由本公司举办的正式设备培训。

代词

使用代词时(比如 等词),必须明确指代的内容,保证只有一个含义。

  • ❌ 从管理系统可以监视中继系统和受其直接控制的分配系统。
  • ✔️ 从管理系统可以监视两个系统:中继系统和受中继系统直接控制的分配系统。

用对

  • 形容词+的+名词:她露出了开心的笑容。
  • 副词+地+动词:她开心地笑了。
  • 动词+得+副词:她笑得很开心。

变化程度

表示增量, 表示定量。

  • 增加到过去的两倍(过去为一,现在为二)
  • 增加了两倍(过去为一,现在为三)

不能用 降低 N 倍减少 N 倍 的表示法,要用 降低百分之几减少百分之几。因为减少(或降低)一倍表示数值原来为一百,现在等于零。

英文风格

复数

英文原文如果使用了复数形式,翻译成中文时,应该将其还原为单数形式。

  • 英文:⋯information stored in random access memory (RAMs)⋯
  • 中文:……存储在随机存取存储器(RAM)里的信息……

缩写

第一次出现英文词汇时,在括号中给出中文标注。此后再次出现时,直接使用英文缩写即可。

IOC(International Olympic Committee,国际奥林匹克委员会)。这样定义后,便可以直接使用「IOC」了。

译名

品牌、产品名、人名、地名等特殊名词,如果来自英文,请使用英文以避免在不同译法之间选择。

文章结构

原则

  • 一个段落只能有一个主题,或一个中心句子。
  • 段落的中心句子放在段首,对全段内容进行概述。后面陈述的句子为核心句服务。
  • 一个段落的长度不能超过七行,最佳段落长度小于等于四行。

标题

层级

  • 一级标题(h1):文章的标题
  • 二级标题(h2):文章主要部分的大标题
  • 三级标题(h3):二级标题下面一级的小标题
  • 四级标题(h4):三级标题下面某一方面的小标题

原则

  • 一级标题下,不能直接出现三级标题。
  • 标题要避免孤立编号(即同级标题只有一个)。
  • 下级标题不重复上一级标题的内容。
  • 谨慎使用四级标题,尽量避免出现,保持层级的简单和防止出现过于复杂的章节。如果三级标题下有并列性的内容,建议只使用项目列表(Item list)。

文章引言

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

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

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

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

引用规范

引用第三方内容时,应注明出处。

One man's constant is another man's variable. — Alan Perlis

如果是全篇转载,请在全文开头显著位置注明作者和出处,并链接至原文。

本文转载自 「安卓果酱」的写作规范

若文章为部分编译,则需在文末注明作者和出处。

本文部分内容编译自 Apple。

本文部分观点来自「小道消息」的微博。

如果格式不允许超链接,请以文本方式直接给出原文链接。如果原文链接太长影响美观,可以使用短链接服务。

本文转载自 WikiQuote:http://bit.ly/UlHIdN

使用外部图片时,必须在图片下方或文末标明来源。

本文部分图片来自 Wikipedia。

题图来自:《春娇与志明》截图。

文档名称

  • 文档的文件名不得含有空格。
  • 文件名建议只使用小写字母,不使用大写字母(可以提高打字速度)。
    • ❌ TroubleShooting.md
    • ✔️ troubleshooting.md
    • 📝 为了醒目,某些说明文件的文件名,可以使用大写字母,比如READMELICENSE
  • 文件名包含多个单词时,单词之间建议使用半角的连字符(-)分隔。
    • ❌ advanced_usage.md
    • ✔️ advanced-usage.md

为什么文件名要小写?by 阮一峰

排版工具

参考资料

关联阅读

最后有一个不情之请:希望看到这里的读者可以帮我扩散这篇文章。因为一看到中英文之间没有空一格,我就浑身难受。所以每多一人采用这份《写作风格手册》,我就可以少加一些空格。多出来的时间,我就可以浪费在美好的事物上面了。

欢迎关注我的其它发布渠道