从功能设计文档生成符合 MMB (Materal.MergeBlock) 框架规范的实体设计文档。使用场景:(1) 根据 FunctionalDesign.md 生成 EntityDesign.md,(2) 设计新的实体类时参考文档格式,(3) 确保实体设计符合 MMB 框架规范。读取 [MMB 框架规范](references/mmb-framework.md) 了解框架接口定义,参考 [文档模板](assets/EntityDesign.template.md) 查看标准格式。
首先读取项目的功能设计文档(通常位于 docs/FunctionalDesign.md),分析:
根据功能设计,识别:
必须遵循的规则:
BaseDomain,获得 ID、CreateTime、UpdateTime 字段IIndexDomain,获得 Index 字段ITreeDomain,获得 ParentID 字段ID(全大写)而非 Id详见 MMB 框架规范
按照 文档模板 的结构生成文档:
文档结构:
实体定义格式:
> 实现 IIndexDomain 和 ITreeDomain 接口使用 erDiagram 格式,仅展示实体间关系:
||--o{(一对多)、||--||(一对一)