54 lines
1.6 KiB
Markdown
54 lines
1.6 KiB
Markdown
# 摄影作品集网站 - 文档总览
|
|
|
|
## 📚 文档结构
|
|
|
|
本项目文档采用清晰的模块化结构，便于快速查找和维护。
|
|
|
|
```
|
|
docs/
|
|
├── README.md # 文档总览（当前文件）
|
|
├── guides/ # 📖 用户指南
|
|
├── technical/ # 🔧 技术文档
|
|
├── operations/ # 🚀 运维部署
|
|
└── api/ # 📡 API文档
|
|
```
|
|
|
|
## 🎯 快速导航
|
|
|
|
### 👥 普通用户
|
|
- [用户指南](./guides/) - 网站使用教程
|
|
|
|
### 💻 开发者
|
|
- [技术文档](./technical/) - 架构设计和开发指南
|
|
- [API文档](./api/) - 接口说明和示例
|
|
|
|
### 🛠️ 运维人员
|
|
- [运维部署](./operations/) - 部署配置和运维指南
|
|
|
|
## 📁 目录说明
|
|
|
|
| 目录 | 用途 | 目标用户 |
|
|
|---|---|---|
|
|
| `guides/` | 使用教程和帮助文档 | 所有用户 |
|
|
| `technical/` | 技术架构和开发文档 | 开发者 |
|
|
| `operations/` | 部署配置和运维文档 | 运维人员 |
|
|
| `api/` | API接口文档 | 前后端开发者 |
|
|
|
|
## 🚀 快速开始
|
|
|
|
### 新用户入门
|
|
1. 查看 [用户指南](./guides/) 了解网站功能
|
|
2. 阅读 [技术文档](./technical/) 了解项目架构
|
|
3. 参考 [运维部署](./operations/) 进行环境搭建
|
|
|
|
### 开发者工作流
|
|
1. **前端开发**: 查看技术文档中的前端部分
|
|
2. **后端开发**: 查看技术文档中的后端部分
|
|
3. **API对接**: 查看api目录下的接口文档
|
|
4. **部署上线**: 参考运维部署文档
|
|
|
|
## 📞 技术支持
|
|
|
|
- **项目地址**: https://photography.iriver.top
|
|
- **文档维护**: Claude Code Assistant
|
|
- **最后更新**: 2024-12-21 |