开发文档
欢迎来到 HeurAMS 开发文档中心。这里汇集了所有技术文档，帮助开发者理解项目架构、API 接口和开发规范。
文档分类
项目结构
了解 HeurAMS 的整体架构和模块组织：
- 项目架构 - 系统架构和模块设计
- 技术栈和依赖关系
- 代码组织规范
协议规范
项目使用的文件格式和数据协议：
- 文件协议规范 - 所有文件格式规范
- Nucleon、Electron、Orbital 文件格式
- 数据交换协议
API 文档
完整的 API 接口文档：
- API 文档 - 所有模块的 API 参考
- Kernel、Interface、Services 等核心模块
- 第三方服务集成接口
开发指南
- 贡献指南 - 参与项目开发的指南
- 代码规范和质量标准
- 测试和部署流程
快速开始
环境搭建
bash
# 克隆项目
git clone https://github.com/your-repo/heurams.git
cd heurams
# 安装依赖
pip install -r requirements.txt
# 运行开发环境
python -m heurams开发流程
- 阅读架构文档 - 了解项目结构
- 查看协议规范 - 理解数据格式
- 参考 API 文档 - 了解接口使用
- 遵循贡献指南 - 确保代码质量
技术栈
后端技术
- Python 3.8+ - 主要编程语言
- Textual - 终端用户界面框架
- SM-2 算法 - 间隔重复算法核心
外部服务
- 生成式 AI - 文本解析和语义理解
- TTS 服务 - 文本转语音功能
- 云存储 - 数据同步和备份
开发工具
- VitePress - 文档系统
- Git - 版本控制
- Pytest - 测试框架
核心模块
Kernel 模块
- 核心业务逻辑
- 间隔重复算法实现
- 记忆数据管理
Interface 模块
- 用户界面组件
- 交互逻辑处理
- 多平台适配
Services 模块
- 基础设施服务
- 文件系统操作
- 网络通信
Providers 模块
- 外部服务集成
- AI 服务接口
- TTS 服务接口
学习路径
初级开发者
- 阅读项目简介和架构概览
- 了解核心算法原理
- 熟悉基本 API 使用
中级开发者
- 深入理解模块间交互
- 学习自定义算法扩展
- 掌握外部服务集成
高级开发者
- 参与核心算法优化
- 设计新的功能模块
- 贡献代码和文档
参与贡献
我们欢迎所有形式的贡献！请查看：
- 贡献指南 - 详细的贡献流程
- 代码审查标准
- 文档编写规范
获取帮助
- GitHub Issues - 报告问题和功能请求
- 社区讨论 - 技术交流和问题解答
- 邮件列表 - 项目公告和更新
注意: 本文档持续更新中。如果您发现任何问题或需要补充的内容，请通过 GitHub Issues 反馈。