This commit is contained in:
iriver
2025-07-09 00:13:41 +08:00
parent 0bfcbe54b1
commit 9376a67052
11 changed files with 2028 additions and 8 deletions

46
docs/README.md Normal file
View File

@ -0,0 +1,46 @@
# 产品文档
本目录包含摄影作品集项目的完整产品文档。
## 文档结构
### 📐 Design设计文档
- UI/UX 设计规范
- 组件设计系统
- 交互设计文档
- 品牌指南和视觉规范
### 🔌 APIAPI 文档)
- API 接口文档
- 数据结构定义
- 接口调用示例
- 错误码说明
### 👥 User Guide用户指南
- 用户操作手册
- 功能使用说明
- 常见问题解答
- 最佳实践指南
### 🛠️ Development开发文档
- 开发环境搭建
- 代码规范和约定
- 开发工作流程
- 测试指南
### 🚀 Deployment部署文档
- 部署配置说明
- 环境变量配置
- 服务器配置要求
- 部署流程和脚本
## 文档维护
请在相应的子目录中维护各类文档,确保文档的及时更新和准确性。
## 贡献指南
1. 在相应目录下创建或更新文档
2. 使用 Markdown 格式编写
3. 确保文档结构清晰、内容准确
4. 添加适当的图片和示例代码