这份手册是照着用户实际要做的事情来组织的:从装好客户端、登录第一个 QQ 账号、接上应用端开始,一路讲到聊天、远端部署和日常维护。里面写的功能和限制,都对照过 main 分支的用户指南和界面实现。
覆盖了哪些内容
常规教程的核对基线是 main 分支的提交 85cd7f40739d38a36c40d9d48ff5b390a2056cff(3.5.2)。在原有 121 项用户任务基础上,新增了 8 项 MCP 任务,共 129 项。MCP 三篇文档对照新版开发实现,已在各页注明版本边界;以安装版本返回的 tools/list 和 get_security_policy 为准,不将开发功能视为 3.5.2 已发能力。只提页面名称、没有具体操作的,不计为覆盖。
| 范围 | 已覆盖 | 清单任务数 |
|---|---|---|
| 入门与组件 | 10 | 10 |
| 机器人管理 | 11 | 11 |
| OneBot 连接 | 7 | 7 |
| 应用实例通用操作 | 7 | 7 |
| 七种应用框架的差异 | 27 | 27 |
| 聊天与截图 | 10 | 10 |
| 远端主机 | 8 | 8 |
| Docker 容器 | 4 | 4 |
| 远端值守 | 6 | 6 |
| OneBot 调试台 | 6 | 6 |
| MCP 与自动化 | 8 | 8 |
| 终端与文件 | 6 | 6 |
| 任务与日志 | 3 | 3 |
| 全局设置与网络 | 11 | 11 |
| 数据与更新 | 5 | 5 |
逐项的清单放在仓库的 scripts/docs-coverage.json 里,记录了每一项对应 main 里的哪些源文件、写在哪篇文档里,以及用来检查的关键词。改完文档以后运行一下 pnpm check:docs,能发现链接失效或者内容被误删的情况。不过步骤写得清不清楚、和软件的实际行为还对不对得上,这些还是要对照源码和界面,由人来复核。
上游插件的各种参数、每一个 OneBot API、框架内部是怎么实现的,这些由各自的项目维护。本手册说明 Desktop 的操作和 NCD MCP 工具参数、错误、权限边界;上游动作的具体参数通过 describe_action 或上游文档查询。
截图与演示
有 12 篇教程带了交互演示,可以暂停、自己接手、重置和放大。演示里的安装、网络测试、OneBot 调用和聊天消息都是模拟出来的。备份那一篇只演示了缓存的扫描与清理,ZIP 的导入导出请到客户端里实际操作。
截图来自项目自带的浏览器演示界面,用的是示例账号和数据,明暗两套主题都有。Windows 原生的截图选区、系统托盘和安装程序的对话框,需要在真实的 Windows 上拍,所以目前只有文字步骤,没有配图。
QQ 登录、SSH 连接、文件传输和模型请求这些,需要你用自己的账号、主机和服务去实际验证。
发现文档和界面对不上
麻烦记下 Desktop、协议端或框架的版本,以及用的是哪台主机、什么部署方式,然后按 排错指南 里的模板,写清楚从哪个入口进去、做了哪些步骤、预期是什么、实际又是什么。附图之前,记得把密码、Token、私钥和私人消息遮掉。
这份文档的结构参考了 GraiaX 文档 的写法。