# 项目文档总览

本目录包含项目各模块的详细设计与接口说明，面向开发者使用和扩展。

---

## 文档列表

| 文档名                                              | 说明                 |
|--------------------------------------------------|--------------------|
| [rule\_mines.md](./dev/rule_mines.md)            | 左线规则接口说明，定义雷布局规则   |
| [rule\_clue.md](./dev/rule_clue.md)              | 右线规则接口说明，定义线索规则    |
| [rule\_clue\_mines.md](./dev/rule_clue_mines.md) | 中线规则接口说明，线索与雷的交互规则 |
| [board\_api.md](./dev/board_api.md)              | 题板与坐标系统接口说明        |
| [utils.md](./dev/utils.md)                       | 工具函数及模块说明          |

---

## 文档结构说明

* ### 各规则文档介绍对应规则的抽象类和具体实现规范。
* ### 题板接口文档说明坐标和数据结构相关接口。
* ### 工具文档提供辅助开发的函数和模块说明。
* ### 设计笔记包含开发中的重要设计决策和规范。

---

## 使用建议

* ### 开发新规则请参照已有规则接口文档规范。
* ### 请保持文档更新与代码同步，确保版本一致性。
