写作指南

前言:期望谋求更易于阅读、言之有物和存在价值的撰文方式。

原则

易于阅读

  • 版式明晰
  • 条理清楚
  • 言简意赅
  • 有结论

言之有物

  • 提纲挈领
  • 阐明主题
  • 字字斟酌
  • 文风统一

存在价值

  • 基于事实
  • 深刻独到
  • 启发思维

细则

前言

对全文进行引导、概括、说明或评价。对以下类型的文章适用:

  • 长篇幅文章
  • 翻译或转载
  • 读后感
  • 系列文章

标题

提取中心思想,扼要简明。

  • 应该包含有意义的文字,避免「如何……」「十大……」的句式
  • 表达个人想法,仅代表自己观点,不代表他人
  • 不夸大文章范围,不摆噱头
  • 避免使用标点

语言和文字

使用中文

任何时候首先、主要使用简体中文。

  • 将繁体中文转化为简体中文,讨论有关「汉字字形」的主题除外
  • 对于显示不友好的字形,附上图像
  • 难以识别的中文字形(如,甲金篆隶草)标注简体楷书
  • 众所周知的外来词不标注源语言和解释
  • 偏僻的外来词在文章中首次出现时以“中文(源语言:解释)” 的形式撰写

其他语言

  • 中文与拼音文字混用时,使用空格隔开,比如英文和朝鲜文
  • 中文与半角符号混用时,亦考虑使用空格
  • 不使用全角拼音文字

翻译

所有外来语都翻译成中文。尽量使用最简洁有力的形式,比如「电邮」和「世贸」。

  • 已翻译的词汇使用约定俗成的形式。除非翻译效果特别离谱,否则不重译
  • 未翻译的词汇,若本身表意或者有中文对照,则意译;反之,为了避免概念重叠,进行音译
  • 拿捏不定的词汇,附上原文
  • 建立《统词表》规范翻译词汇

标点

  • 表达一个完整的意思后,使用句号
  • 破折号和冒号可以用作“解释说明”
  • 尽量少用、不用感叹号
  • 使用中文样式的直角引号(「」)
  • 引号亦作「讽刺」之用
  • 分号亦表示「转折」
  • 斜线表示「和(或)」,用空格隔开
  • 列表句末不使用标点
  • 序号考虑使用「甲乙丙……」和「子丑寅……」
  • 省略号的形式是「……」,不用于表达语气
  • 书刊使用书名号

数字与符号

  • 单位换算成中文读者常用单位,比如:人民币、米
  • 数字使用半角,不进行分组(123,456,789)。为了方便表达,可以选取更恰当的单位,比如:万
  • 尽量不在中文中使用 & 符
  • 人民币的符号 ¥ 是半角的
  • 不使用表情符
  • 「××」用乘号表示,不用字母 x

代码

使用 <code> 标签,不推荐 <pre> 标签。如不使用,机器会将之当普通文字进行翻译,也不利于辅助阅读。

  • 个别代码(比如函数)不应用高亮样式
  • 超过一句话的代码,应用高亮样式
  • 代码左右不使用引号

正文行文

思想与框架

撰写中

文风

  • 避免「如果……」的句式
  • 融会贯通地使用成语和俗语
  • 进行表述时,使用约定俗成的词汇
  • 使用经过考验的自造词和古字
  • 下定义前充分讨论
  • 拒绝使用「××体」等
  • 表达完一层意思后,起新段落
  • 避免「和」「与」的连用造成歧义
  • 长短句切合,减少复句的使用率
  • 撰文前多参考相关文章,避免观点狭隘、思想空洞
  • 勿反复使用一个词
  • 避免形容词的滥用,将行为和依据可执行化
  • 提倡引经据典
  • 发布前省视每一个字,确保没有一个字是打错、用错、多余
  • 可选的注释性文字使用 <span title=""> 标签
  • 小众的缩略语(包括人名、地名、专业名词等)使用 <abbr> 标签注明全称

避免西式中文

  • 避免使用「我不认为……」的句式
  • 推荐将「被字句」改写成「把字句」。比如:「他被授予××」 → 「学院授予他××」
  • 正确区分和使用「的地得」
  • 一个修饰语只使用一个「的」

更新内容

文章观点有重大变更后,

  • 在原文文末附上“最后更新:日期”
  • 在最新文章的末尾添加提示

富文本格式

正文

  • 不使用段首缩进
  • 避免使用超过2种以上的字体
  • 不在英文上应用难看的宋体
  • 中文环境的字号在14像素以上
  • 仅使用黑色、灰度颜色和超链接颜色
  • 强调时可以加粗,但谨慎使用
  • 不使用斜体
  • 区分和使用有序 / 无序列表
  • 引用使用 <blockquote> 标签
  • 更改 <abbr> 样式,使其更容易识别
  • 正文与附注之间明确分隔

图片

添加图片的目的在乎帮助理解文字。

  • 摒弃可选的图片
  • 图片添加标题,位于图片下方
  • 图片及其标题,作为整体与正文明确分隔
  • 正文内容位于图片标题下方
  • 添加 alt 属性,以利于辅助阅读
  • 不添加 title 属性
  • 超过650像素添加原图超链接,否则不添

超链接

为了不影响阅读流畅度,正文内不设超链接;相关条目附在参阅下。

  • 不设置 title 属性,除非为了补充说明
  • 不设置 target 属性,让读者把握网站去留

网源(Web Feed)

将正文样式映射到网源文件,保证统一的阅读体验

参阅

参考资料

撰写该文参考的文章、图表等条目,使用 <blockquote> 标签。格式:序号+来源+标题+超链接。其中,

  • 序号 使用 <ol> 标签
  • 来源 首选作者名,其次用出处名
  • 标题 使用原标题。如果原标题不够明了则删减原标题。除非标题着实难以理解,否则不另起标题。如果是文章,使用书名号;若原文非中文,将标题翻译成中文,格式如下:《中文标题》(×语)

延伸阅读

值得读者拓展阅读的条目。格式同“参考资料”。

其他

辅助阅读

帮助视觉 / 听觉障碍的读者阅读文章。具体细则已分散在不同的章节里。

广告

安放位置不影响阅读体验。比较合适的地方有:

  • 边栏
  • 文末

参考资料

  1. 知乎问答 《「可能吧」和「Apple4.us」等群体博客的文章有什么编辑范式?》 http://www.zhihu.com/question/19551844

延伸阅读

  1. 小轰 《统词表》 http://cuikai-wh.com/guide-vocabulary

最后更新:2012-03-10

评论

《对话守则》第一条:对话的目的是寻求真理。

以下选填: