36 lines
1.1 KiB
Markdown
36 lines
1.1 KiB
Markdown
|
# 文档索引
|
||
|
|
|
||
|
|
> 本目录包含适用于所有项目的通用文档
|
||
|
|
|
||
|
|
---
|
||
|
|
|
||
|
|
## 项目结构
|
||
|
|
|
||
|
|
- **[AI友好项目结构.md](AI友好项目结构.md)** - AI 友好项目结构设计指南
|
||
|
|
- **[模块信息模板.md](模块信息模板.md)** - 模块信息文档模板
|
||
|
|
- **[输入输出映射模板.yaml](输入输出映射模板.yaml)** - 输入输出映射模板
|
||
|
|
- **[文档导航模板.yaml](文档导航模板.yaml)** - 文档导航模板
|
||
|
|
|
||
|
|
---
|
||
|
|
|
||
|
|
## 文档说明
|
||
|
|
|
||
|
|
本目录旨在提供通用的项目文档和最佳实践，适用于所有类型的项目开发。
|
||
|
|
|
||
|
|
### 主要内容
|
||
|
|
|
||
|
|
- **AI 友好项目结构**：帮助 AI 快速理解模块职责、依赖关系和业务流程
|
||
|
|
- **标准化文档模板**：统一的文档结构和格式
|
||
|
|
- **可视化工具**：依赖图和调用链生成
|
||
|
|
- **最佳实践**：命名规范、文件大小限制、依赖规则等
|
||
|
|
|
||
|
|
### 如何使用
|
||
|
|
|
||
|
|
1. 参考 `ai-friendly-project-structure.md` 设计项目结构
|
||
|
|
2. 使用提供的模板文件创建模块文档
|
||
|
|
3. 运行生成脚本创建依赖图和调用链
|
||
|
|
4. 保持文档与代码同步更新
|
||
|
|
|
||
|
|
---
|
||
|
|
|
||
|
|
*本目录会持续更新，欢迎贡献更多通用文档。*
|