Appearance
如何更新文档
新增页面
- 在
docs/srs/或docs/architecture/下新增 Markdown 文件,文件名使用数字前缀保证排序稳定,例如:08-xxx.md。 - 在
docs/.vitepress/config.js的 sidebar 中新增对应链接。 - 本地检查链接与标题是否正确。
修改现有页面
- 优先保持章节编号与侧边栏一致。
- 需求条目建议使用统一模板(功能描述/优先级/输入/操作序列/输出/补充说明)。
- 若修改涉及 Demo 口径或路线图:同步更新
docs/roadmap.md与docs/srs/07-acceptance.md。
进度与变更记录(必须)
- 每次代码更新(新增功能、修复 bug、调整接口)都必须在
docs/progress/00-status.md的“更新记录”新增一条。 - 建议写清:改了什么、影响哪个 Demo、如何验证、关联 commit。
前端开发文档更新规范
前端相关改动需同步维护以下文档:
- 页面/组件变更:更新
docs/frontend/01-pages-components.md(路由、Props、事件、插槽说明)。 - 状态管理/WebSocket 变更:更新
docs/frontend/02-state-websocket.md(store 字段、action、WS 事件协议)。 - 新增 API 端点:同步更新
docs/dev/02-api-reference-full.md(完整参考)与docs/dev/01-backend-api.md(快速索引)。 - UI 设计变更:更新
docs/dev/04-frontend-ui-design.md。 - 内部模块接口变更:更新
docs/dev/05-internal-interfaces.md。 - 新增文档页面:在
docs/.vitepress/config.js的对应 sidebar 分区添加链接,并确认 nav 导航无遗漏。
编写约定
- 文档统一使用 UTF-8 编码。
- 尽量使用短句与列表,保持可读性。