127 lines
4.5 KiB
Markdown
127 lines
4.5 KiB
Markdown
# 项目文档索引
|
|
|
|
本目录包含 KeyPressRemark 项目的完整技术文档，为开发者、用户和维护者提供全面的参考资料。
|
|
|
|
## 📚 文档导航
|
|
|
|
### 用户文档
|
|
|
|
- **[README.md](../README.md)** - 项目概述和快速入门指南
|
|
- 功能特性介绍
|
|
- 安装和使用说明
|
|
- 基本操作指南
|
|
- 打包部署说明
|
|
|
|
### 开发者文档
|
|
|
|
- **[开发者指南 (DEVELOPER_GUIDE.md)](./DEVELOPER_GUIDE.md)** - 完整的开发指导
|
|
- 开发环境设置
|
|
- 项目架构详解
|
|
- 代码规范和最佳实践
|
|
- 测试和调试指南
|
|
- 性能优化建议
|
|
|
|
- **[环境配置指南 (ENVIRONMENT_SETUP.md)](./ENVIRONMENT_SETUP.md)** - 详细的环境配置说明
|
|
- 系统要求详解
|
|
- Python 环境配置
|
|
- 依赖包详细说明
|
|
- 常见问题解决方案
|
|
- 依赖管理最佳实践
|
|
|
|
### 技术文档
|
|
|
|
- **[API 参考](./API_REFERENCE.md)** (计划中)
|
|
- 核心类和方法文档
|
|
- 使用示例
|
|
- 参数说明
|
|
|
|
- **[架构设计](./ARCHITECTURE.md)** (计划中)
|
|
- 系统架构图
|
|
- 模块设计原理
|
|
- 技术选型说明
|
|
|
|
## 🔍 快速查找
|
|
|
|
### 按使用场景查找
|
|
|
|
| 我想要... | 参考文档 |
|
|
|----------|----------|
|
|
| 了解项目功能 | [README.md](../README.md) |
|
|
| 快速使用程序 | [README.md - 使用指南](../README.md#使用指南) |
|
|
| 设置开发环境 | [环境配置指南](./ENVIRONMENT_SETUP.md) |
|
|
| 参与代码开发 | [开发者指南](./DEVELOPER_GUIDE.md) |
|
|
| 解决安装问题 | [环境配置指南 - 常见问题](./ENVIRONMENT_SETUP.md#常见问题解决) |
|
|
| 了解代码架构 | [开发者指南 - 项目架构](./DEVELOPER_GUIDE.md#项目架构) |
|
|
| 学习按键原理 | [开发者指南 - 核心技术](./DEVELOPER_GUIDE.md#核心技术) |
|
|
|
|
### 按技术领域查找
|
|
|
|
| 技术领域 | 相关文档 |
|
|
|---------|----------|
|
|
| Python 环境 | [环境配置指南 - Python 环境](./ENVIRONMENT_SETUP.md#python-环境) |
|
|
| PyQt5 界面 | [开发者指南 - PyQt5 技术](./DEVELOPER_GUIDE.md#pyqt5-技术) |
|
|
| Windows API | [开发者指南 - Windows API 技术](./DEVELOPER_GUIDE.md#windows-api-技术) |
|
|
| 按键模拟 | [开发者指南 - 按键发送原理](./DEVELOPER_GUIDE.md#按键发送原理) |
|
|
| 依赖管理 | [环境配置指南 - 依赖管理](./ENVIRONMENT_SETUP.md#依赖管理最佳实践) |
|
|
| 测试调试 | [开发者指南 - 测试指南](./DEVELOPER_GUIDE.md#测试指南) |
|
|
|
|
### 按问题类型查找
|
|
|
|
| 问题类型 | 解决方案文档 |
|
|
|---------|-------------|
|
|
| 安装失败 | [环境配置指南 - 常见问题](./ENVIRONMENT_SETUP.md#常见问题解决) |
|
|
| 权限问题 | [开发者指南 - 调试技巧](./DEVELOPER_GUIDE.md#调试技巧) |
|
|
| 按键无效 | [开发者指南 - 常见问题 Q1](./DEVELOPER_GUIDE.md#q1-按键发送不生效) |
|
|
| 界面卡顿 | [开发者指南 - 常见问题 Q2](./DEVELOPER_GUIDE.md#q2-界面冻结) |
|
|
| 版本冲突 | [环境配置指南 - 问题2](./ENVIRONMENT_SETUP.md#问题-2-pyqt5-qt5-版本冲突) |
|
|
|
|
## 📝 文档贡献
|
|
|
|
### 文档规范
|
|
|
|
- 使用 Markdown 格式
|
|
- 遵循中文技术文档规范
|
|
- 包含完整的目录结构
|
|
- 提供实用的代码示例
|
|
- 及时更新版本信息
|
|
|
|
### 贡献流程
|
|
|
|
1. **发现问题**: 在使用过程中发现文档问题或缺失
|
|
2. **创建 Issue**: 在 GitHub 上创建文档改进建议
|
|
3. **编写内容**: 按照现有格式编写或修改文档
|
|
4. **提交 PR**: 提交 Pull Request 进行审查
|
|
5. **合并更新**: 审查通过后合并到主分支
|
|
|
|
### 文档维护
|
|
|
|
- **定期更新**: 随代码变更同步更新文档
|
|
- **版本标记**: 重要变更需要标记版本号
|
|
- **链接检查**: 定期检查文档内链接有效性
|
|
- **示例验证**: 确保代码示例能正常运行
|
|
|
|
## 🔗 相关资源
|
|
|
|
### 官方资源
|
|
|
|
- **项目仓库**: [GitHub Repository](https://github.com/your-repo)
|
|
- **问题反馈**: [GitHub Issues](https://github.com/your-repo/issues)
|
|
- **功能讨论**: [GitHub Discussions](https://github.com/your-repo/discussions)
|
|
|
|
### 技术参考
|
|
|
|
- **PyQt5 官方文档**: [https://doc.qt.io/qtforpython/](https://doc.qt.io/qtforpython/)
|
|
- **Windows API 参考**: [https://docs.microsoft.com/en-us/windows/win32/api/](https://docs.microsoft.com/en-us/windows/win32/api/)
|
|
- **Python 官方文档**: [https://docs.python.org/3/](https://docs.python.org/3/)
|
|
|
|
### 社区资源
|
|
|
|
- **PyQt5 中文教程**: 各大技术博客和教程网站
|
|
- **Windows 编程资源**: MSDN 和相关技术社区
|
|
- **Python 包管理**: pip 和 uv 官方文档
|
|
|
|
---
|
|
|
|
**最后更新**: 2024-01-01
|
|
**文档版本**: v1.0
|
|
**维护者**: xiao liu |