跳转至

正文结构检查清单

面向开源工程知识库正文(非求职材料)。新增或大改专题时,按本清单自检; 机器校验仍以 scripts/verify_knowledge_metadata.py 为准(30 秒版、深挖问答、元数据、 以及 tip 禁止词)。

推荐叙事顺序

顺序 块 要回答什么
1 30 秒版 / 要点卡 是什么、边界、一个失败不变量
2 3 分钟版 为什么存在、关键机制 3 点内
3 10 分钟版 状态机 / 架构图 / 对照表
4 生产场景 真实压力与分层策略
5 排查与工具 要落哪些字段与指标
6 架构取舍 何时不用
7 深挖问答 ≥1 个「为什么不选另一方案」
8 反模式 可操作的错误做法
9 证据边界 code_refs / harness 能证明什么、不能证明什么
10 相关链接 概念地图、相邻专题(双向更好)

模板见 template.md。

tip / note 禁止词(对外导航文案)

下列词出现在 !!! tip / !!! note / !!! warning / !!! abstract 块中会令校验失败 (正文论述区不强制,但仍建议避免求职口吻):

  • 岗位 P0 / 目标岗位 / JD 含
  • 必问(可用「关键边界」「先澄清」替代)
  • 简历(除明确讨论证据诚实边界的正文句子外,勿放 tip)
  • 面试(资料引用放 sources / 延伸阅读即可)

发布前勾选

  • [ ] 开篇先给不变量与失败边界,无绝对化全球结论
  • [ ] 有状态机或等价对照表
  • [ ] 反模式可执行(不是空喊「要注意」)
  • [ ] 证据标签与仓库实际一致(见 领域能力优先级)
  • [ ] tip 无禁止词;若有概念地图,链到 docs/maps/
  • [ ] 跑通:.venv/bin/python scripts/verify_knowledge_metadata.py