Skip to Content
统一维护项目说明、流程手册和模板文档,减少知识散落。
内容模型

内容模型

为了让文档站长期可维护,建议先统一分类方式,再持续扩充内容。

推荐目录

目录适合放什么示例
content/首页级说明和总览项目总览、入门指南
content/workflows/流程型文档发布、回滚、值班、交接
content/templates/可复用模板会议纪要、复盘、方案模板

文件命名建议

  • 使用英文短横线命名,例如 release-checklist.mdx
  • 避免 final-v2-new.mdx 这种难以理解的文件名
  • 一个文件只表达一个明确主题

Front Matter 约定

每篇文档建议至少包含:

--- title: 发布检查清单 description: 上线前后的关键确认项,避免遗漏。 ---

_meta.js 的职责

_meta.js 决定导航展示顺序、标题以及页面级配置。它比仅靠文件名更适合长期维护。

export default { "release-checklist": { title: "发布检查清单" }, handover: { title: "交接流程" } }

当文档数量变多时,先优化目录结构和 _meta.js,比单纯继续堆页面更重要。