# 📚 Getinge Web 项目文档中心 ## 🎯 欢迎 欢迎来到 Getinge Web 项目文档中心!这里包含了项目的所有相关文档,帮助团队成员快速了解项目架构、开发规范和使用指南。 ## 🚀 快速开始 ### 新用户 如果您是第一次接触这个项目,建议按以下顺序阅读: 1. [项目概述](./README.md) - 了解项目基本情况 2. [产品需求文档](./product/requirements.md) - 了解产品功能 3. [开发环境搭建](./development/setup.md) - 搭建开发环境 4. [用户手册](./product/user-manual.md) - 学习如何使用系统 ### 开发者 如果您是开发团队成员,建议重点关注: 1. [开发环境搭建](./development/setup.md) - 环境配置 2. [代码规范](./development/code-standards.md) - 编码标准 3. [系统架构设计](./architecture/system-design.md) - 技术架构 4. [API 接口文档](./architecture/api.md) - 接口说明 ### 运维人员 如果您负责系统部署和维护,建议阅读: 1. [部署指南](./deployment/guide.md) - 部署流程 2. [环境配置](./deployment/environment.md) - 环境设置 3. [监控运维](./deployment/monitoring.md) - 运维指南 ## 📁 文档分类 ### 🎯 产品文档 - [产品需求文档](./product/requirements.md) - 产品功能需求说明 - [产品设计文档](./product/design.md) - 产品界面和交互设计 - [用户手册](./product/user-manual.md) - 用户操作指南 - [功能说明](./product/features.md) - 功能特性介绍 ### 🏗️ 技术架构 - [系统架构设计](./architecture/system-design.md) - 整体系统架构 - [技术选型说明](./architecture/tech-stack.md) - 技术栈选择说明 - [数据库设计](./architecture/database.md) - 数据库结构设计 - [API 接口文档](./architecture/api.md) - 接口接口说明 ### 💻 开发文档 - [开发环境搭建](./development/setup.md) - 开发环境配置指南 - [开发规范](./development/standards.md) - 开发流程和规范 - [代码规范](./development/code-standards.md) - 代码编写标准 - [组件开发指南](./development/components.md) - 组件开发说明 ### 🚀 部署运维 - [部署指南](./deployment/guide.md) - 系统部署流程 - [环境配置](./deployment/environment.md) - 环境配置说明 - [监控运维](./deployment/monitoring.md) - 系统监控和运维 ### 📖 其他文档 - [项目变更记录](./changelog.md) - 项目版本变更历史 - [常见问题](./faq.md) - 常见问题解答 - [联系方式](./contact.md) - 项目相关联系方式 - [文档编写规范](./standards/documentation-standards.md) - 文档编写标准 ## 🔍 文档搜索 ### 按功能模块搜索 - **用户管理**: 用户认证、权限控制、角色管理 - **业务管理**: 课程、学生、预约、问卷 - **系统管理**: 配置、日志、监控 - **技术架构**: 前端框架、后端服务、数据库 ### 按文档类型搜索 - **需求文档**: 产品需求、功能说明 - **设计文档**: 架构设计、界面设计 - **开发文档**: 环境搭建、编码规范 - **部署文档**: 部署流程、运维指南 - **用户文档**: 操作手册、常见问题 ### 按技术栈搜索 - **前端**: Vue.js、Element UI、Vuex、Vue Router - **后端**: Node.js、Express、MySQL - **工具**: Webpack、ESLint、Jest - **部署**: Nginx、PM2、Docker ## 📊 文档状态 | 文档类型 | 总数 | 已完成 | 进行中 | 待开始 | |----------|------|--------|--------|--------| | 产品文档 | 4 | 1 | 0 | 3 | | 技术架构 | 4 | 1 | 0 | 3 | | 开发文档 | 4 | 2 | 0 | 2 | | 部署运维 | 3 | 1 | 0 | 2 | | 其他文档 | 4 | 3 | 0 | 1 | | **总计** | **19** | **8** | **0** | **11** | ## 🔄 文档更新 ### 最近更新 - [2024年] 创建项目文档目录结构 - [2024年] 完成核心文档编写 - [2024年] 建立文档编写规范 ### 更新计划 - [ ] 完善产品设计文档 - [ ] 补充 API 接口文档 - [ ] 完善用户手册 - [ ] 添加更多示例和截图 ## 📝 文档贡献 ### 如何贡献文档 1. 阅读 [文档编写规范](./standards/documentation-standards.md) 2. 选择合适的文档模板 3. 编写文档内容 4. 提交审核和发布 ### 文档审核流程 1. **自检**: 作者完成初稿后进行自我检查 2. **同行评审**: 邀请同事进行技术评审 3. **专家审核**: 重要文档邀请专家审核 4. **发布确认**: 最终确认后发布文档 ## 🆘 获取帮助 ### 文档问题 如果您在阅读文档时遇到问题: - 检查文档版本是否最新 - 查看相关文档是否有更新 - 联系文档维护人员 ### 技术问题 如果您在使用系统时遇到技术问题: - 查看 [常见问题](./faq.md) - 联系技术支持团队 - 提交问题反馈 ### 项目问题 如果您有项目相关的问题: - 联系项目负责人 - 通过项目管理工具提交问题 - 参加项目会议讨论 ## 📞 联系方式 ### 项目团队 - **项目负责人**: [姓名] - [邮箱] - **技术负责人**: [姓名] - [邮箱] - **产品负责人**: [姓名] - [邮箱] ### 技术支持 - **技术支持邮箱**: support@example.com - **技术支持电话**: 400-XXX-XXXX - **在线客服**: [客服系统链接] ### 文档维护 - **文档负责人**: [姓名] - [邮箱] - **文档团队**: docs@example.com ## 📚 相关资源 ### 外部链接 - [Vue.js 官方文档](https://vuejs.org/) - [Element UI 文档](https://element.eleme.io/) - [Vue CLI 文档](https://cli.vuejs.org/) ### 内部资源 - [项目代码仓库](https://github.com/username/getinge-web) - [项目管理工具](https://project.example.com) - [测试环境](https://test.example.com) --- *最后更新:2024年* *如有问题或建议,请联系文档维护团队*