写功能文档维护说明
怎样新增功能文档
每个新功能放进对应业务域,并加入版本功能清单。
最简单的做法
- 找到项目和版本,例如
hblhxny/v1.0-pro。 - 找到对应业务域,例如
domains/qms/。 - 在业务域目录下新建一个 MDX 文件。
- 按 功能文档模板 填写业务逻辑。
- 把功能加到版本首页的“业务域和功能”。
- 把文件名加到业务域的
meta.json,让侧栏能够看到。
目录例子
hblhxny/
└── v1.0-pro/
├── index.mdx # 功能清单
├── changes.mdx # 版本更新记录
└── domains/
├── meta.json # 业务域顺序
└── qms/
├── meta.json
├── index.mdx # QMS 功能清单
└── qms-inspection.mdx功能页能回答“这个功能怎么运行、出问题去哪查”就够了。