184 lines
5.0 KiB
Markdown
184 lines
5.0 KiB
Markdown
# 文档整理说明
|
||
|
||
## 📁 文档结构
|
||
|
||
所有文档已按照项目结构整理到对应的 `docs/` 目录中。
|
||
|
||
### 后端文档 (go/docs/)
|
||
|
||
```
|
||
go/docs/
|
||
├── README.md # 文档索引（新增）
|
||
├── 后端开发规则.md # 开发规范
|
||
├── 接口文件.md # 接口文档
|
||
├── 服务端启动命令.md # 启动说明
|
||
├── QUICK_START.md # 快速开始（新增）
|
||
├── README_STORAGE.md # 存储功能说明（新增）
|
||
├── storage-config-guide.md # 存储详细指南（新增）
|
||
├── DEPLOYMENT_CHECKLIST.md # 部署清单（新增）
|
||
├── IMPLEMENTATION_COMPLETE.md # 实现报告（新增）
|
||
├── 文档整理说明.md # 本文件（新增）
|
||
└── sql/
|
||
└── add_storage_config_table.sql # 数据库迁移
|
||
```
|
||
|
||
### 前端文档 (platform/docs/)
|
||
|
||
```
|
||
platform/docs/
|
||
├── README.md # 文档索引（新增）
|
||
├── dictionary-usage.md # 字典使用
|
||
├── pinia-dict-guide.md # Pinia字典指南
|
||
├── 一键复制.md # 复制功能
|
||
├── 拼接接口路径.md # 接口路径
|
||
├── 接口调用.md # 接口调用
|
||
├── 获取缓存数据.md # 缓存数据
|
||
├── 调用图片上传组件.md # 图片上传
|
||
└── 调用字典.md # 字典调用
|
||
```
|
||
|
||
### 项目根目录
|
||
|
||
```
|
||
项目根目录/
|
||
└── README.md # 总导航（新增）
|
||
```
|
||
|
||
## 📝 文档分类
|
||
|
||
### 1. 开发文档
|
||
- 后端开发规则.md
|
||
- 接口文件.md
|
||
- 服务端启动命令.md
|
||
|
||
### 2. 功能文档
|
||
- dictionary-usage.md
|
||
- pinia-dict-guide.md
|
||
- 调用字典.md
|
||
- 调用图片上传组件.md
|
||
- 等...
|
||
|
||
### 3. 存储配置功能文档（新增）
|
||
- QUICK_START.md - 快速开始
|
||
- README_STORAGE.md - 功能说明
|
||
- storage-config-guide.md - 详细指南
|
||
- DEPLOYMENT_CHECKLIST.md - 部署清单
|
||
- IMPLEMENTATION_COMPLETE.md - 实现报告
|
||
|
||
### 4. 索引文档（新增）
|
||
- 项目根目录/README.md - 总导航
|
||
- go/docs/README.md - 后端文档索引
|
||
- platform/docs/README.md - 前端文档索引
|
||
|
||
## 🔍 文档查找
|
||
|
||
### 按功能查找
|
||
|
||
**存储配置功能**:
|
||
1. 快速开始 → `go/docs/QUICK_START.md`
|
||
2. 功能说明 → `go/docs/README_STORAGE.md`
|
||
3. 详细指南 → `go/docs/storage-config-guide.md`
|
||
4. 部署清单 → `go/docs/DEPLOYMENT_CHECKLIST.md`
|
||
|
||
**字典功能**:
|
||
1. 使用说明 → `platform/docs/dictionary-usage.md`
|
||
2. Pinia指南 → `platform/docs/pinia-dict-guide.md`
|
||
|
||
**图片上传**:
|
||
1. 组件调用 → `platform/docs/调用图片上传组件.md`
|
||
|
||
### 按角色查找
|
||
|
||
**新手开发者**:
|
||
1. 项目总览 → `README.md`
|
||
2. 后端开发 → `go/docs/后端开发规则.md`
|
||
3. 快速开始 → `go/docs/QUICK_START.md`
|
||
|
||
**运维人员**:
|
||
1. 启动命令 → `go/docs/服务端启动命令.md`
|
||
2. 部署清单 → `go/docs/DEPLOYMENT_CHECKLIST.md`
|
||
|
||
**产品经理**:
|
||
1. 功能说明 → `go/docs/README_STORAGE.md`
|
||
2. 实现报告 → `go/docs/IMPLEMENTATION_COMPLETE.md`
|
||
|
||
## 📋 文档规范
|
||
|
||
### 文件命名
|
||
- 中文文档：使用中文名称（如：后端开发规则.md）
|
||
- 英文文档：使用大写+下划线（如：README_STORAGE.md）
|
||
- 索引文档：统一使用 README.md
|
||
|
||
### 文档结构
|
||
```markdown
|
||
# 标题
|
||
|
||
## 概述
|
||
简要说明文档内容
|
||
|
||
## 目录
|
||
- 章节1
|
||
- 章节2
|
||
|
||
## 详细内容
|
||
...
|
||
|
||
## 相关链接
|
||
- 链接1
|
||
- 链接2
|
||
```
|
||
|
||
### 文档位置
|
||
- 后端相关文档 → `go/docs/`
|
||
- 前端相关文档 → `platform/docs/`
|
||
- 移动端相关文档 → `babyhealth/docs/`
|
||
- 项目总览 → 根目录 `README.md`
|
||
|
||
## 🔄 文档更新
|
||
|
||
### 新增文档
|
||
1. 确定文档类型（后端/前端/通用）
|
||
2. 放入对应的 `docs/` 目录
|
||
3. 更新对应的 `README.md` 索引
|
||
4. 如需要，更新根目录 `README.md`
|
||
|
||
### 修改文档
|
||
1. 直接修改对应文档
|
||
2. 更新文档底部的"最后更新"时间
|
||
3. 如有重大变更，更新索引文档
|
||
|
||
### 删除文档
|
||
1. 删除文档文件
|
||
2. 从索引中移除引用
|
||
3. 检查其他文档中的链接
|
||
|
||
## ✅ 整理完成清单
|
||
|
||
- [x] 创建后端文档索引 (go/docs/README.md)
|
||
- [x] 创建前端文档索引 (platform/docs/README.md)
|
||
- [x] 创建项目总导航 (README.md)
|
||
- [x] 移动存储功能文档到 go/docs/
|
||
- [x] 删除根目录的临时文档
|
||
- [x] 创建文档整理说明（本文件）
|
||
|
||
## 📌 注意事项
|
||
|
||
1. **文档位置**: 所有文档必须放在对应项目的 `docs/` 目录中
|
||
2. **索引更新**: 新增文档后必须更新索引文件
|
||
3. **链接检查**: 修改文档位置后检查所有引用链接
|
||
4. **命名规范**: 遵循统一的文件命名规范
|
||
5. **内容质量**: 保持文档的准确性和时效性
|
||
|
||
## 🎯 后续优化
|
||
|
||
- [ ] 添加文档搜索功能
|
||
- [ ] 生成文档网站（如使用 VuePress）
|
||
- [ ] 添加文档版本管理
|
||
- [ ] 自动化文档检查工具
|
||
- [ ] 文档贡献指南
|
||
|
||
---
|
||
|
||
**整理完成时间**: 2024-01-01
|
||
**整理人员**: AI Assistant
|