docs: add developer architecture handbook
This commit is contained in:
Misaka
@@ -66,7 +66,10 @@ docs/developer/
|
||||
- 新增核心模块时，同步补一篇对应的模块文档
|
||||
- 发生重要重构时，更新相关架构文档和决策记录
|
||||
- 文档优先解释“职责、边界、调用关系”，而不是堆砌实现细节
|
||||
- 每篇文档尽量附上关键文件路径和 `mermaid` 图
|
||||
- 文档应当多用、善用 `mermaid` 做图形化表达
|
||||
- 遇到结构、分层、调用链、时序、流程时，优先考虑先画图再解释
|
||||
- 图负责帮助读者快速建立整体认知，文字负责解释细节和边界
|
||||
- 文档尽量附上关键文件路径，并保持图和正文一一对应
|
||||
- 文档中的路径、模块名、调用链描述应与当前代码保持一致
|
||||
|
||||
## 当前状态
|
||||
|
||||
Reference in New Issue
Block a user