TYJH 项目功能文档
写功能文档维护说明

功能文档模板

新增功能时复制这页的结构。

一句话说明

这个功能解决什么现实问题?

谁在什么时候使用

  • 使用人:
  • 触发场景:
  • 完成标志:

业务流程

开始
  → 第一步
  → 第二步
  ├─ 正常情况 → 完成
  └─ 异常情况 → 怎么处理

业务规则

  • 什么情况下允许操作?
  • 什么情况下不能操作?
  • 谁可以操作?
  • 操作后哪些数据会变化?

代码位置

类型位置作用
页面或接口入口用户从哪里进入
Service核心业务逻辑
Mapper / SQL查询和数据修改

变更和验证

项目内容
对应分支
对应提交
最近更新
验证状态代码梳理 / 编译 / 本地运行 / 测试环境 / 客户现场

On this page