修改文件结构,统一文档格式
This commit is contained in:
52
docs/README.md
Normal file
52
docs/README.md
Normal file
@@ -0,0 +1,52 @@
|
||||
# 项目文档目录
|
||||
|
||||
本目录包含宁夏智慧养殖监管平台的所有技术文档和报告。
|
||||
|
||||
## 📋 文档索引
|
||||
|
||||
### 💾 系统报告
|
||||
- [`data-sync-fix-report.md`](data-sync-fix-report.md) - 经纬度数据同步问题修复报告
|
||||
- [`farms-data-import-summary.md`](farms-data-import-summary.md) - 农场静态数据导入总结
|
||||
- [`location-data-validation-report.md`](location-data-validation-report.md) - 经纬度数据传递验证报告
|
||||
|
||||
### 🗺️ 第三方服务
|
||||
- [`baidu-map-license.md`](baidu-map-license.md) - 百度地图商用授权解决方案
|
||||
|
||||
### 📊 系统监控
|
||||
- [`performance-monitoring.md`](performance-monitoring.md) - 性能监控系统完整文档
|
||||
|
||||
### 📚 项目设计
|
||||
- [`architecture.md`](architecture.md) - 系统架构设计文档
|
||||
- [`design.md`](design.md) - 详细设计文档
|
||||
- [`development-plan.md`](development-plan.md) - 开发计划文档
|
||||
- [`task-list.md`](task-list.md) - 任务清单文档
|
||||
|
||||
### 💼 示例代码
|
||||
- [`examples/performance-monitor-integration.js`](examples/performance-monitor-integration.js) - 性能监控集成示例
|
||||
|
||||
## 📂 文档分类
|
||||
|
||||
### 运维报告
|
||||
包含系统维护、数据修复、功能验证等相关的技术报告,记录了系统运行过程中的重要问题解决方案。
|
||||
|
||||
### 服务集成
|
||||
包含第三方服务(如百度地图API)的配置、授权、使用说明等文档。
|
||||
|
||||
### 系统监控
|
||||
包含性能监控、系统健康检查、监控指标等相关的配置和使用文档。
|
||||
|
||||
### 架构设计
|
||||
包含系统架构、详细设计、开发计划等技术设计文档。
|
||||
|
||||
### 示例代码
|
||||
包含各种功能集成的示例代码和最佳实践。
|
||||
|
||||
## 🔄 文档维护
|
||||
|
||||
- 所有技术报告都应记录在此目录下
|
||||
- 定期更新过时的文档内容
|
||||
- 新增重要功能或修复时应更新相关文档
|
||||
|
||||
---
|
||||
|
||||
*最后更新: 2025年1月*
|
||||
Reference in New Issue
Block a user