Skip to content

待完善清单

这页只保留“下一步应该补什么”,方便继续迭代。

高优先级

1. 安装包获取与首次设备绑定说明

当前缺口:

  • 官网下载入口在哪里
  • 不同平台怎么安装
  • 第一次登录后的设备绑定和授权流程
  • 首次打开后的权限说明

为什么优先:

因为文档站已经补了“安装与登录”入口,但还缺真正贴近发版和分发流程的说明,普通用户第一次拿到安装包时仍然可能卡住。

2. 当前桌面端开发指南

当前缺口:

  • desktop/ 的真实目录说明
  • 前端启动方式
  • src-tauri 调试方式
  • 当前测试命令
  • 旧文档和新工作区的迁移说明

为什么优先:

因为旧文档还在写 archive/desktop-legacy,非常容易把新人带偏。

补充说明:

  • 这篇是开发者文档,不是普通用户使用文档
  • 之所以还没直接迁入,不是因为不重要,而是因为原文已经过期

3. CLI 实操文档

当前缺口:

  • 当前版本到底哪些命令已经可用
  • 各命令的安装和启动前提
  • 常见错误怎么排查

为什么优先:

CLI 使用指南 已经进入文档站了,但当前更像“可读入口 + 能力边界说明”,还缺一篇真正照着就能跑的实操手册。

4. MCP 接入实操文档

当前缺口:

  • 怎么配置一个 MCP 服务
  • 常见传输方式怎么选
  • 连接失败怎么排查

为什么优先:

现在只有概念说明,没有真正能照着操作的步骤。

中优先级

5. 配额与用量说明拆分

建议拆成两篇:

  • 用户版:配额是什么、超了会怎样、怎么查看
  • 开发者版:接口、字段、统计方式

6. 管理后台开发文档

建议补这些内容:

  • 路由结构
  • 页面模块划分
  • API service 约定
  • 权限和角色处理方式

7. 桌面端运行时架构精简版

现在已经有一版 Agent Runtime 当前架构,但信息量仍然偏大,后面仍建议补一版“开发者能快速看懂”的精简说明。

低优先级

8. 品牌与设计系统文档

可以把 docs/设计规范.md 重构成:

  • 品牌色
  • 字体层级
  • 圆角、间距、按钮规范
  • 桌面端与官网共用的设计 token

9. 发布与版本文档

后面可以考虑补:

  • 桌面端发版流程
  • 后台发布流程
  • 版本号规范

建议维护方式

后续继续补文档时,建议坚持 3 条规则:

  1. 先判断文档是给用户看,还是给开发者看
  2. 只把长期有效的信息放进独立文档站
  3. 阶段性快照、迁移记录、ADR 保留在原目录,不直接当公开入口

内容通过 Markdown 维护,适合持续迭代。