Back to Gin Vue Admin

模块说明索引

aiDoc/modules/module-index.md

2.9.2976 B
Original Source

模块说明索引

推荐写法

每个重要模块或插件,尽量用一份文档回答下面几个问题:

  1. 这个模块是做什么的
  2. 它的后端入口在哪里
  3. 它的前端入口在哪里
  4. 它依赖哪些数据或其他模块
  5. 它对外暴露什么契约
  6. 它有哪些必须记住的限制

当前建议的模块分组

  • system-core: 项目核心能力,主要分布在 server/web/src/
  • plugins: 插件化能力,分布在 server/plugin/web/src/plugin/
  • deploy: 运行与发布相关能力,位于 deploy/

已存在的约束文档

  • backend-layer-rules.md: 后端分层、模型、Service、API、Router、初始化入口
  • plugin-development.md: 前后端插件结构、插件入口与开发流程

命名建议

新增模块文档时,优先使用这类文件名:

  • system-core.md
  • plugin-<name>.md
  • deploy-runtime.md

模块说明要聚焦职责和边界,不要堆砌实现细节。