# 文档索引 本文档提供所有项目文档的索引和导航。 ## 📚 文档概览 ### 核心文档 | 文档 | 描述 | 适用人员 | |-----|------|---------| | [README.md](../README.md) | 项目总览和快速导航 | 所有人 | | [QUICKSTART.md](../QUICKSTART.md) | 快速开始指南 | 新开发者 | | [PROJECT_README.md](../PROJECT_README.md) | 项目详细说明 | 所有人 | ### 开发文档 | 文档 | 描述 | 适用人员 | |-----|------|---------| | [DEVELOPER_GUIDE.md](../DEVELOPER_GUIDE.md) | 开发者开发指南 | 开发者 | | [API_DOCUMENTATION.md](../API_DOCUMENTATION.md) | API 接口文档 | 前后端开发者 | ### 部署文档 | 文档 | 描述 | 适用人员 | |-----|------|---------| | [DEPLOYMENT.md](../DEPLOYMENT.md) | 部署指南 | 运维人员 | ### 更新日志 | 文档 | 描述 | 适用人员 | |-----|------|---------| | [CHANGELOG.md](../CHANGELOG.md) | 版本更新记录 | 所有人 | ### 功能说明 | 文档 | 描述 | 适用人员 | |-----|------|---------| | [CONFIG_AUTO_CREATE_SUMMARY.md](../CONFIG_AUTO_CREATE_SUMMARY.md) | 职位配置功能说明 | 开发者、使用者 | | [FIELD_CONFIG_CACHE_README.md](../FIELD_CONFIG_CACHE_README.md) | 缓存功能说明 | 开发者 | ## 🗺️ 阅读路径 ### 对于新开发者 1. 阅读 [QUICKSTART.md](../QUICKSTART.md) - 快速启动 2. 阅读 [PROJECT_README.md](../PROJECT_README.md) - 了解项目 3. 阅读 [DEVELOPER_GUIDE.md](../DEVELOPER_GUIDE.md) - 学习开发 4. 阅读 [API_DOCUMENTATION.md](../API_DOCUMENTATION.md) - 了解接口 ### 对于运维人员 1. 阅读 [PROJECT_README.md](../PROJECT_README.md) - 了解项目 2. 阅读 [DEPLOYMENT.md](../DEPLOYMENT.md) - 部署指南 ### 对于使用者 1. 阅读 [README.md](../README.md) - 项目总览 2. 阅读 [PROJECT_README.md](../PROJECT_README.md) - 功能说明 3. 阅读功能说明文档 - 了解特性 ## 📝 文档维护 ### 文档更新原则 - 代码更新时同步更新文档 - 功能变更时更新相关文档 - 定期检查文档准确性 - 删除过时内容 ### 文档格式规范 - 使用 Markdown 格式 - 标题层级清晰 - 代码示例完整 - 截图清晰 ## 🔍 快速查找 ### 按主题查找 - **安装配置**:[QUICKSTART.md](../QUICKSTART.md) - **开发规范**:[DEVELOPER_GUIDE.md](../DEVELOPER_GUIDE.md) - **API 调用**:[API_DOCUMENTATION.md](../API_DOCUMENTATION.md) - **部署上线**:[DEPLOYMENT.md](../DEPLOYMENT.md) - **版本更新**:[CHANGELOG.md](../CHANGELOG.md) ### 按问题查找 - **如何快速启动?** → [QUICKSTART.md](../QUICKSTART.md) - **如何开发新功能?** → [DEVELOPER_GUIDE.md](../DEVELOPER_GUIDE.md) - **如何调用 API?** → [API_DOCUMENTATION.md](../API_DOCUMENTATION.md) - **如何部署?** → [DEPLOYMENT.md](../DEPLOYMENT.md) - **功能如何实现?** → 功能说明文档 ## 📞 反馈与贡献 文档问题请提交 Issue 或联系维护团队。 **文档版本**:v1.0 **最后更新**:2024