39 lines
1.2 KiB
Markdown
39 lines
1.2 KiB
Markdown
|
# 项目文档
|
||
|
|
|
||
|
|
## 概述
|
||
|
|
|
||
|
|
本文档目录包含了锡林郭勒盟安格斯牛数字化管理平台的所有相关文档。
|
||
|
|
|
||
|
|
## 文档列表
|
||
|
|
|
||
|
|
### 1. 架构文档
|
||
|
|
- [系统架构文档](../ARCHITECTURE.md) - 系统整体架构设计
|
||
|
|
- [详细需求文档](../REQUIREMENTS.md) - 功能和非功能需求说明
|
||
|
|
- [开发计划文档](../DEVELOPMENT_PLAN.md) - 项目开发计划和时间安排
|
||
|
|
|
||
|
|
### 2. 技术文档
|
||
|
|
- API接口文档 (待编写)
|
||
|
|
- 数据库设计文档 (位于[backend/database](file:///Users/ainongkeji/code/vue/xlxumu/backend/database)目录)
|
||
|
|
- 前端组件文档 (各前端项目中)
|
||
|
|
- 部署文档 ([deployment/README.md](file:///Users/ainongkeji/code/vue/xlxumu/deployment/README.md))
|
||
|
|
|
||
|
|
### 3. 用户文档
|
||
|
|
- 用户手册 (待编写)
|
||
|
|
- 管理员手册 (待编写)
|
||
|
|
- 操作指南 (待编写)
|
||
|
|
|
||
|
|
### 4. 其他文档
|
||
|
|
- 测试报告 (待编写)
|
||
|
|
- 项目总结报告 (待编写)
|
||
|
|
|
||
|
|
## 文档维护
|
||
|
|
|
||
|
|
所有文档应保持最新状态，与代码实现保持一致。当功能发生变化时，应及时更新相关文档。
|
||
|
|
|
||
|
|
## 贡献指南
|
||
|
|
|
||
|
|
如果您需要更新文档，请遵循以下步骤：
|
||
|
|
1. Fork项目仓库
|
||
|
|
2. 创建新的文档分支
|
||
|
|
3. 进行文档修改
|
||
|
|
4. 提交Pull Request
|