Skip to content

视觉约束与禁用项

解决什么问题:所有 Type 共用的视觉规范——保证 wiki 整体风格一致。

它是什么

视觉规范是"语言的语法"——文档结构是语义,视觉规范是表达方式。两者同等重要

必须遵守

表格优先于段落

  • 能用表格表达的不用段落
  • 表格列数 ≤ 5 列
  • 表格行数 ≤ 10 行(超出拆表)

mermaid 优先于纯文字

  • 能用流程图/关系图/序列图表达的,不用纯文字
  • 复杂图(≥ 5 节点)用 mermaid,不用 ASCII art
  • 简单示意(≤ 3 节点)可以用 ASCII

行内引用标置信度

markdown
> 置信度:★★★★☆(综合推断)
> 置信度:★★★★★(Vernon IDDD Ch.2 原文转述)
  • 源典转述:必须标置信度(默认 5 星)+ 出处
  • AI 推断:标置信度(默认 3 星)+ 注明"综合推断"
  • 实践归纳:标置信度(4 星)+ 注明"实践归纳"

链接风格

  • 内部链接用绝对路径:[链接文字](/l1-modeling/02-strategic/)
  • 不用相对路径./bounded-context.md 不行
  • 不用 .html 后缀:cleanUrls 已开,写 /bounded-context/ 不要 /bounded-context.html

文档末尾"相关链接"格式

markdown
## 相关链接

- [链接文字 1](/path/)
- [链接文字 2](/path/)
- [源典精读](/path/)
  • 每篇至少 3 条
  • 链接到已经存在的文档(不能是 stub 占位,build 会失败)
  • 链接文字是完整语义(不是"点这里")

禁用项

不写"什么不是 X"

❌ "X 不是 Y,也不是 Z,它是 W" ✅ "X 是 W"

只说"是什么"和"怎么做"。用否定解释概念会留下更多困惑

不写大段引用

❌ 直接贴 200 字原文 ✅ "钱学森 Ch 1 §1.4 强调:'物理系统都是非线性的'"

转述即可,引用 1-2 句。wiki 是知识库不是文献集

不写空段落占位

## 怎么做\n\nTODO: 待补充 ✅ stub 状态:一句话"内容待填充"

stub 状态用一行 > 内容待填充 带过,不要写半成品段落

不写"总结"段

❌ "综上所述,本文档介绍了..." ✅ 结尾用"相关链接"代替

写完不写总结。相关链接 = 文档的"延伸阅读"=比"总结"更有用

不写"待办事项"在文档正文

❌ 文档里有"## TODO"段 ✅ TODO 写在 evolution-log 或 git issue

文档是"已知的知识",TODO 是"未完成的工作"——不要混在一起

不用 emoji 装饰正文

❌ "我们使用 🔥 快速迭代" ✅ "我们使用快速迭代"

sidebar 已经用 emoji 装饰,正文里再出现就是视觉污染

不用复杂 ASCII art 替代 mermaid

❌ 用 50 行 ASCII 画一个 8 节点架构图 ✅ 用 mermaid 5 行画同样的图

ASCII 适合 1-3 节点的快速示意,超过用 mermaid

通用格式细节

元素规范
标题层级H1(1 个)→ H2 → H3,不跳级
强调**加粗** 用于关键概念,斜体 不用
代码行内用 `code`,块用 ``` 围栏
列表无序用 -,有序用 1.(数字自动连续)
引文> blockquote,置信度标注写在引文内
数学简单公式用行内 $\frac{1}{2}$,复杂用代码块 math
表格对齐默认左对齐,不用 :---:

怎么用

写文档前过一遍这个清单

[ ] 表格能用吗?
[ ] 流程图能用 mermaid 吗?
[ ] 置信度标注了吗?
[ ] 链接是绝对路径吗?
[ ] 没有"什么不是"段?
[ ] 没有大段引用?
[ ] 没有 TODO 在正文?
[ ] 没有 emoji 装饰?

写完后再过一遍——用这套规范做最终 self-review。

常见误区

  1. "这里特殊所以违反一下"——视觉规范的"特殊例外"会在 3 个月内扩散到 10 个地方
  2. "我加了 emoji 强调重点"——sidebar 的 emoji 已经是装饰,正文不需要
  3. "引用比转述更准确"——读者要的是"知识"不是"原文存档"

关键洞察

视觉规范 = 减少阅读摩擦

当所有文档用同一套视觉规则,读者不必为每篇"重新适应"——打开任何一篇都像"回家"。

相关链接

从名家方法论与工程化思路中蒸馏出自己的工程体系。