文档协作规范
1. 基本原则
- 文档和代码一起演进。
- 决策写入文档,不只存在聊天记录中。
- 一页只解决一个主题,命名清晰可检索。
2. 编写建议
- 标题直接说明主题。
- 先写结论,再写细节。
- 对版本、范围、前提条件写清楚。
- 重要概念统一用词并与术语表一致。
3. VitePress 维护注意事项
- 新文件加入后同步更新
SUMMARY.md。 - 保持层级不要过深,优先控制在两层。
- 页面之间尽量建立交叉链接,减少重复说明。
4. 提交流程建议
- 修改 Markdown 内容。
- 检查导航与相对链接。
- 本地执行
npm run docs:build。 - 提交代码评审。
- 合并到
main后确认 GitHub Actions 构建通过。