# XQPath 文档中心
本目录包含 XQPath 项目的完整文档体系,包括技术规范、开发计划、用户指南等。
## 📁 文档结构
### 📋 技术规范 (`rfcs/`)
正式的技术规范和设计文档:
- **RFC-001**: [jq 语法兼容性分析](rfcs/RFC-001-jq-syntax-compatibility.md)
- **RFC-002**: [表达式系统设计](rfcs/RFC-002-expression-system.md)
- **RFC-003**: [内置函数系统](rfcs/RFC-003-builtin-functions.md)
### 🔧 开发计划
### 📈 版本规划 (`planning/`)
- [后续版本路线图](planning/post-release-roadmap.md)
- [v1.2 开发路线图](planning/roadmap-v1.2.md)
- [v1.3 开发路线图](planning/roadmap-v1.3.md)
### 🏗️ 设计文档 (`design/`)
具体功能的详细设计:
- [用户函数实现计划](design/user-functions-implementation.md)
### 📦 发布记录 (`releases/`)
版本发布历史和报告:
- [v0.0.1 发布报告](releases/v0.0.1-release-report.md)
- [v1.1 进度报告](releases/v1.1-progress-report.md)
- [v1.2 发布说明](releases/v1.2-release-notes.md)
### 历史文档 (`archive/`)
已完成版本的历史文档:
- [v1.1 实现计划](archive/implementation-plan-v1.1.md)
- **[v1.4 版本归档](archive/v1.4/)** - v1.4 完整系列文档 (v1.4.0-v1.4.3) ⭐
- **[v1.4.3 子版本](archive/v1.4/v1.4.3/)** - v1.4.3 最终完成版本
## 🚀 阅读指南
### 新用户
1. 先阅读 [README.md](../README.md) 了解项目概况
2. 查看 [快速开始指南](quick-start-guide.md) 学习基本使用
3. 参考 [RFC 文档](rfcs/) 了解技术细节
### 开发者
1. 查看 [技术规范](rfcs/) 了解系统设计
2. 参考 [开发计划](#开发计划) 了解当前进度
3. 查看 [版本规划](planning/) 了解项目方向
### 贡献者
1. 阅读 [实施时间表](implementation-timeline.md) 了解开发节奏
2. 查看待实现功能(标记为 🚧 的项目)
3. 参考已完成功能的设计文档
## 📊 当前状态
### ✅ 已完成
- **v1.4 系列**: 完整的调试和配置管理系统(已归档到 [v1.4 文档](archive/v1.4/))
- v1.4.1: 基础调试系统(结构化日志、CLI 调试选项、错误诊断)
- v1.4.2: 性能监控系统(性能指标收集、基准测试、性能报告)
- v1.4.3: 配置管理和交互式调试(配置模板、交互式调试器)
### 📋 规划中
- 后续版本功能规划见 [规划文档](planning/)
## 📝 文档维护
### 文档分类
- **RFC**: 技术规范和系统设计
- **计划**: 开发计划和实施方案
- **规划**: 版本路线图和长期规划
- **指南**: 用户文档和使用说明
- **报告**: 发布记录和总结报告
- **归档**: 已完成版本的历史文档
### 更新原则
1. **及时性**: 功能实现后及时更新相关文档
2. **准确性**: 确保文档与代码实现保持一致
3. **完整性**: 重要功能都应有对应的设计文档
4. **可维护性**: 保持清晰的文档结构和分类
5. **归档管理**: 完成版本及时归档,保持主文档简洁
---
**维护团队**: XQPath 项目组
**最后更新**: 2025 年 8 月 2 日
**文档版本**: v2.1 (v1.4 版本归档完成)