Writing Spec · Overview
写作规范 · 板块总览
一份契约 · 三份示例 · 一份检查清单
写作规范 · 板块总览
本板块交付
一份契约(写作规范)、三份示例(L1A/L1B/L2)、一份检查清单——覆盖 06_docs 下所有 MD 文档的生产全流程。
📋 本板块文档
-
17 章主规范 + 2 份附录,含 frontmatter、分级、Admonition、Mermaid、表格、命名等全部契约条款。
-
带星空粒子 + 三色涟漪 + 统计数字的最豪华形态示例。
-
带简洁渐变 Hero 的主题文档示例,适用于产品 Datasheet、白皮书。
-
无 Hero 的普通长文示例,标题带品牌加粗线,适用于大多数内部文档。
-
对照本清单逐项勾选,验证站点是否达到豪华基线。
🔁 写作流程
```mermaid graph LR A[复制示例 MD] → B[改 frontmatter] B → C[按规范填正文] C → D[本地 mkdocs serve 预览] D → E{视觉达标?} E -- 是 → F[mkdocs.yml nav 登记] E -- 否 → C F → G[提交 PR]
classDef ok fill:#E8F4F1,stroke:#5DDECF,stroke-width:2px
classDef action fill:#F5F2EA,stroke:#D4A574,stroke-width:2px
class F,G ok
class A,B,C,D action