✍️ 写作范式(Writing Style)
解决什么问题:world-map 任何一篇文档在写之前先选 Type 再写——Type 决定结构,结构决定可读性、可搜索性、可维护性。
它是什么
核心原则:Type → Structure → Content
Type 决定 ┌──── H1
├──── > 解决什么问题
├──── ## 它是什么 / 关键属性 / 怎么用 ...
Structure └──── ## 相关链接
Content 才能开始写4 个 Type + 1 个 stub:
| Type | 用途 | 典型例子 | 篇幅 |
|---|---|---|---|
| A 概览页 | L 层入口、meta 分区索引 | l1-modeling/01-overview/ | 50-80 行 |
| B 概念页 | 解释"是什么 + 怎么做" | meta/source/cybernetics/trilemma/ | 60-100 行 |
| C 案例页 | 端到端贯通的真实场景 | l2-design/06-cases/(待写) | 80-150 行 |
| D stub | 待填充的占位文档 | 所有 02-X/ 等 group 入口 | 4 行 |
判断流程:
Q1: 这是入口/索引吗? → Type A 概览页
Q2: 解释一个概念或方法? → Type B 概念页
Q3: 展示一个端到端场景? → Type C 案例页
Q4: 还没有内容? → Type D stub核心约束:每篇文档写之前先定 Type,写完后自检该 Type 的所有 section 是否齐全。
关键属性
| 属性 | 值 |
|---|---|
| frontmatter 必填 | title, type, layer, group |
| frontmatter 选填 | status, confidence, source, last_updated, related |
| type 取值 | overview / concept / case / stub |
| layer 取值 | L1 / L2 / L3 / L4 / L5 / meta |
| 每个 group 默认 type | 01-overview 永远 A,02+~05 永远 B,06 永远 C,07 永远 B(源典) |
| related 字段 | 必填 2 条(每篇至少 2 个反向链接) |
详细规范
按 Type 分四份子文档:
通用规范(所有 Type 共用):
阅读路径
新读者(要写第一篇文档):从 Type B 概念页 开始——90% 的文档是这个 Type。
要重构现有文档:先看 Type A 概览页 确认入口结构。
关键洞察
Type 先行 = 减少写作时的决策负担
写文档最大的浪费是"边写边想结构"——每段写什么、占什么位置。先定 Type = 把"结构"提前固化 = 写的时候只关心"内容填哪"。
统一的 Type 让 wiki 变成"可预测的"
读者打开任何一篇文档,知道会看到什么 section、什么顺序——学习成本极低。
常见误区
- "我这一篇特殊,不适合用标准 Type"——99% 的"特殊"是因为没想清楚应该选哪个 Type。先套标准 Type,写完再调整
- 同一篇文档混用多个 Type——比如"概览 + 概念" 合一 → 拆成两篇
- Type D 长期不填——如果一个 stub 6 个月内没人填,评估是否真的需要(写进 evolution-log)
相关链接
- 首页
- meta/conventions/(旧版文档撰写约定,本范式是其升级版)
- meta/ai-collaboration/(AI 协作约定)
- meta/evolution-log/(骨架演进日志)