📚 RPA App 文档索引
欢迎使用 RPA App!本文档索引将帮助您快速找到所需的文档资源。
🎯 文档分类导航
🚀 新手入门
文档 |
描述 |
适用人群 |
快速开始指南 |
项目快速上手指南,包含安装、启动和基本测试 |
新用户 |
项目概览 |
项目整体架构、技术栈和核心功能模块介绍 |
开发者、架构师 |
目录结构说明 |
项目文件和目录结构详细说明 |
开发者 |
💻 开发指南
文档 |
描述 |
适用人群 |
开发命令手册 |
构建、调试、设备管理等常用命令 |
开发者 |
代码规范 |
ESLint、Prettier、Git 提交规范等 |
开发者、团队 |
Husky 配置指南 |
Git hooks 和 Import 自动排序配置 |
开发者 |
📜 脚本开发
文档 |
描述 |
适用人群 |
脚本使用指南 |
动态脚本编写规范、API 使用和示例 |
脚本开发者 |
ADB 推送指南 |
通过 ADB 推送外部脚本的完整指南 |
脚本开发者 |
测试脚本说明 |
测试脚本目录说明和使用方法 |
测试人员 |
🔧 调试和故障排除
文档 |
描述 |
适用人群 |
调试指南 |
JSON 解析错误、网络连接问题等故障排除 |
开发者、用户 |
脚本错误处理 |
脚本错误分析、处理和解决方案 |
脚本开发者 |
🌐 Web 调试
🤖 RPA 模块
文档 |
描述 |
适用人群 |
RPA 模块文档 |
原生 RPA 模块使用说明和开发指南 |
原生开发者 |
🎯 按使用场景查找文档
🆕 我是新用户,想快速上手
- 先阅读 快速开始指南
- 了解 项目概览
- 查看 目录结构说明
👨💻 我要参与开发
- 阅读 开发命令手册
- 遵循 代码规范
- 配置 Husky 和 Import 排序
📝 我要编写脚本
- 学习 脚本使用指南
- 了解 ADB 推送功能
- 参考 测试脚本示例
🐛 我遇到了问题
- 查看 调试指南
- 参考 脚本错误处理
- 使用 Web 调试界面 进行调试
🌐 我要使用 Web 调试
- 阅读 Web 调试说明
- 详细了解 Web 调试界面
🔧 我要开发原生功能
- 学习 RPA 模块文档
- 参考 开发命令手册
📋 文档维护说明
文档更新原则
- 📝 及时更新: 功能变更时同步更新相关文档
- 🎯 用户导向: 从用户角度编写,注重实用性
- 📚 分类清晰: 按功能和使用场景合理分类
- 🔗 交叉引用: 相关文档间建立链接关系
贡献指南
如果您发现文档问题或有改进建议:
- 创建 Issue 描述问题
- 提交 Pull Request 修复文档
- 遵循项目的 代码规范
文档状态
状态 |
说明 |
文档列表 |
✅ 完整 |
内容完整,定期维护 |
大部分文档 |
🔄 更新中 |
正在更新或完善 |
- |
⚠️ 待完善 |
内容不完整,需要补充 |
DIRECTORY_STRUCTURE.md |
🆘 获取帮助
如果您在使用过程中遇到问题:
- 查阅相关文档: 根据上述分类找到对应文档
- 查看调试指南: 调试指南 包含常见问题解决方案
- 使用 Web 调试: Web 调试界面 提供实时调试功能
- 查看日志: 使用
adb logcat
查看详细日志信息
最后更新: 2024 年 12 月 维护者: RPA App 开发团队