写作风格规范
社群首页、文档站与新闻导读由不同的人撰写,读者读到的写法要前后一致。这一页是三个网站共用的写作规范,也是各 repo 说明文件的依据。各站自己的格式与流程另外写,文档站的见贡献者百科。
适用范围
- 社群首页的页面与社群动态(
anoni-net/www) - 文档站三个语系的内容(
anoni-net/docs的docs/) - 新闻导读的文章(
anoni-net/news),篇幅、结构与第一段的新闻写法另见该 repo 的guides/posts.md - 各 repo 的说明文件:根目录的
README.md、CONTRIBUTING.md、AGENTS.md、CLAUDE.md、NOTICE,以及各子目录的README.md
这一页是精简版,规则以正体中文版为准。英文另有一套规则,见英文版。照录他人说法(引用、受访内容、外部来源的原始标题)不在此限。
可以机器判断的规则写成了 linter,放在 anoni-net/docs 的 tools/docs_style_lint.py,只收 .md 与 .js。检查其他 repo 的文件时传完整路径,linter 依路径里的 zh-TW、zh-CN、en 选择规则集,传相对路径可能套错语系:
# 在 anoni-net/docs 的根目录执行
python3 tools/docs_style_lint.py /path/to/www/pages/zh-CN/about.md
规则文件会引用被禁的句型当例子,linter 依文件名豁免这一页与文档站的贡献者百科。文档站 CI 的触发条件与只检查变更行的旗标,写在贡献者百科的「写作风格规范」一节。
禁用句型与标点
- 不使用
——(双破折号)作为句中插入语。需要补充说明时,改用冒号、逗号,或拆成两句 - 不使用「不是...而是...」句型。改用正向直述。省略「而」、靠逗号衔接的「不是甲,是乙」也算同一个句型
- 避免用「;」断句,优先用「。」或拆句
- 并列词语或短语请用「、」,不要用全形「/」当列举符号(半形
/用在路径、URL、技术惯用写法)
并列引号的标点
连续的「」引号之间要加「、」。错误与正确对照:
-
「决策者」「被咨询者」「需被告知者」 -
「决策者」、「被咨询者」、「需被告知者」
段落语气
- 像一位了解主题的社群成员在解释,而非教科书或百科条目
- 不在每段末尾加总结句,让段落自然收尾
- 避免「值得注意的是」、「总的来说」、「综上所述」、「谈的是」、「指的是」、「涵盖的是」这类开头
- 避免「这…」、「这个…」开头,与「其实」、「换句话说」这类填充转折,能删则删
- 「这」不要在同一句里堆叠。同句出现 3 次以上,或两个「这」中间隔不到 9 个字,就把其中一个换成它实际指的名词,或整句重写。例:
这件事说明有人在卖这个概念,不等于这套技术已经在运作改成有人在卖这个概念,不等于技术已经在运作。全文密度可以拿来抓大方向,站上每千汉字约 5 个是常态,超过 10 个的文章通常整段都要重写。zhe-repeat规则只扫同句堆叠,全文密度要人工判断
标点集合
正文主要使用:「、」、「,」、「。」、「:」、「「」」、「()」。技术术语(Tor、OONI、IP、USB 等)保持英文原文,不加引号。
版面组件里的项目分隔可以用半形间隔点(·),例如首页主按钮下方那一列次要链接。限定在组件上,句子里的并列词语仍然用「、」。
用词
口语字改书面语。例:「讲」改成「提到」、「说明」。常见的还有:
| 口语 | 书面语 |
|---|---|
| 跑(执行软件) | 依语境用执行、架设、运作、运营 |
| 拿到 | 取得 |
| 得先、得靠 | 需先、需仰赖 |
| 动手 | 实际操作、着手、实现 |
| 踩到 | 遇到 |
| 找上门 | 依语境用接洽、找上、追究 |
| 省事、省力 | 简便、容易 |
| 怎样 | 副词用「如何」,修饰语(怎样的 X)用「什么样的」。「长怎样」整句改写,不要写成「长如何」 |
| 照旧 | 维持原状 |
| 差不多 | 相近 |
| 挂了 | 无法连接 |
| 搞错、弄坏 | 出错、损坏 |
照录他人说法不在此限。例:把读者的感受写成「连不上」、「跑很慢」时保留原样,因为那正是要呈现的口吻。