Files
workphone-sdk/开发文档/README.md
2026-05-24 14:29:42 +08:00

6.7 KiB
Raw Blame History

tags, doc-type, layer, related
tags doc-type layer related
工作手机
索引
索引 README.md
开发文档/README
开发进度总表

文档说明

工作手机SDK v3.0 - 开发文档

🗂️ 项目目录总览Obsidian 入口)2、架构/01-总览/项目目录总览.md

📖 必读 · 完整整合手册(补全包已并入)

9、手册/工作手机·五图总览与使用手册.md — v2.1
五图架构 + 补全包九模块 + API + 真机验收 + 无线 Frida · 一份读通

管理Skill本项目目录下 机擎/SKILL.md(火炬总控,五人分配:阿表/阿机/阿桥/阿端/阿服)
更新2026-05-24 | 当前项目状态:总进度 99.5%
约定:顶层1、需求10、项目管理 十个编号目录Soul 等平台调研在 1、需求/03-调研/平台分析/
标签与关联:每篇 MD 含 YAML tags / related / parent + 文末 🔗 关联导航 + 顶部 ![文档说明] 头图;规范见 机擎/阿表/开发文档结构规范/SKILL.md §四B、§四C。

⚠️ 真机开发铁律(强制 · 每次必守)

2、架构/01-总览/真机开发铁律.md — 机器真机 + 卡若AI禁止占位/模拟;标完成须真机 E2E 留痕。
门禁:8、部署/05-测试验收/scripts/real_device_gate.sh · 清单:8、部署/05-测试验收/真机开发每轮检查清单.md


项目管理规则(必守)

机擎负责所有项目管理、人员安排、全员学习开发文档;每次开发由机擎安排任务。

  • Skill 位置机擎/SKILL.md(火炬总控,阿表/阿机/阿桥/阿端/阿服 按岗位分配。与卡若AI 为交互关系卡若AI 涉及工作手机时读取该 Skill 并按其规则执行。
  • 开发文档归属:所有开发文档内容必须在 工作手机/开发文档/ 目录下不在此目录外新增或生成开发文档类内容新增文档归入对应子目录1、需求 … 10、项目管理平台分析按平台分子目录如 Soul
  • 每次开发:由机擎整理项目(读进度总表、工作日志、状态检查)→ 安排、分配任务 → 执行并更新文档。

项目简述

工作手机SDK v3.0 是存客宝的 AI 手机控制引擎,用于替代奥创,实现:

  • 存客宝/触客宝通过统一 API 控制手机(微信、抖音、小红书、闲鱼等)
  • 设备主动连接云端WebSocket、心跳可配置、指令 ACK
  • 服务端 FastAPI + WebSocket Hub + 脚本引擎Skill设备端 Agent + uiautomator2
  • 数据闭环MySQL存客宝+ MongoDBworkphone_sdk+ Redis

当前状态M1M4、M7M11 已 100%M5 脚本引擎约 75%、M8 Agent 约 95%M6 抓包待做、M12 AI Agent 约 50%。


开发文档规则(与全站一致,机擎保证执行)

  • 每目录除 README 外最多 3 个主文档(基础规则);超出须合并,与全栈开发文档规则一致。
  • 超过 3 个时:必须启动整文件合并,将多篇合并为 ≤3 个主文档;合并时不得导致数据和相关内容丢失(可合并为同一文档内多章节或附录)。
  • 子目录(如 6、后端 下的 github核心代码/docs/不计入「3 个主文档」数量。

进度只看两处(单一进度视图)

文档 说明
10、项目管理/开发进度总表.md 唯一进度文档:按模块 M1M12 的完成度、待办、验证方式
2、架构/01-总览/系统架构.md § 3.0 模块拆解基准:需求→任务→进度对应表

看进度时:先看 开发进度总表,再按需看 系统架构 § 3.0 的模块拆解。


开发文档四类分类(文档各就各位,不散落)

开发文档按 4 类 归纳,现有文档分别归属以下 4 类,便于查找与维护:

分类 所含目录 说明
一、需求与架构 1、需求2、架构3、原型 需求、架构设计、原型规范
二、开发与接口 4、前端5、接口6、后端 前端/接口/后端实现与规范
三、部署与数据 7、数据库8、部署05-测试验收 数据库、部署、真机验收脚本
四、手册与进度 9、手册10、项目管理 操作手册、进度验收
  • 根目录不放置除本 README 以外的文档。

开发文档结构(子目录与主文档)

目录 主文档≤3 说明
1、需求 分层 01-概述/ 02-业务/ 03-调研/修改/ 增量 需求与澄清
2、架构 分层目录 01-总览/ 02-技术基座/ 03-通道与设备/ 04-交互图/ 05-规范/PNG 在 images/0104/ 架构与 §3.0 模块拆解;规范见 机擎/阿表/开发文档结构规范
3、原型 分层 01-规范/ 原型规范
4、前端 分层 01-通用规范/ 02-管理端/ 03-工具/ 前端规范
5、接口 分层 0106;矩阵与开发日志在 06-验收与矩阵/ API、对接、验收矩阵
6、后端 分层 01-服务端/ 02-设备端/ 03-规范汇总/ 服务端+Agent
7、数据库 分层 01-设计/ 02-规范/ 数据层
8、部署 分层 0105;真机脚本在 05-测试验收/ 部署 + 验收
9、手册 主手册 + 02-操作指南/ 03-验证/ 04-专项/ 操作与验证
10、项目管理 根目录真源 3 文件 + 02-测试报告/ 03-计划与专项/ 进度(唯一入口)

快速启动SDK

cd sdk && ./scripts/start_sdk.sh

路径以「工作手机」项目根目录为基准。详见 9、手册/02-操作指南/SDK操作手册.md

统一测试账号15880802661 / kr123456详见 8、部署/01-本地环境/本地环境凭证.md

🔗 关联导航

方向 文档
↔ 相关 [[开发文档/README