风格规则(共享,可强制执行)
内部风格集中在一处。标有“(test)”的条目由 tests/validate.py 强制执行;违反会使构建失败。完整的叙述版本是
仓库根目录的 spec/conventions.md。
硬性规则
- 不使用长破折号。绝不使用“—”(U+2014)。使用逗号、冒号、括号或两个句子。短破折号“–”只允许用于数字范围,
如
1–9或2.1–2.8。(test) - 不使用陈词滥调。不要使用“not only … but also”、“but also”或“load-bearing”。避免“It’s important to note”、“In today’s fast-paced world”、 “It’s crucial to consider”、“It appears that”、“One could argue”,以及“it’s not just X, it’s Y”的套路。(test,针对前三项)
- 术语在首次使用时给出定义。每个主题第一次使用时,展开缩写并定义行话,例如“mean time to recovery (MTTR)”。
- 把关键概念链接到维基百科,首次提及时,每个主题一次,仅限正文。形式:
[term](https://en.wikipedia.org/wiki/Article_Title)。 绝不放在标题、表格、代码或参考文献部分。(链接形式是 test) - 只使用真实的参考文献。真实作品的作者和标题。不使用编造的标题、作者或 URL。
- 点明操纵路径。指标家族的主题要说明指标如何被操纵,以及哪道护栏能抓住它(主题 1.2)。
语气
- 温暖、直接、鼓舞人心。直接对读者说话。句子短,用词简单。从要点开始。
- 观点明确且务实。对供应商保持中立。只把产品作为事实性示例提及。
结构 (test)
- 内容主题严格使用
chapter-template.md中的部分顺序。 - 第一个标题是
# N.M Title(带点的主题编号),并与文件补零的PP-CC前缀一致。 - 每个部分内的编号是连续的,并从 N.0 开始。
编辑之后
- 如果你更改了主题集合,请更新
spec/structure.md并运行just nav。 - 始终运行
just test。