Skip to content

Latest commit

 

History

History
95 lines (80 loc) · 7.22 KB

README.md

File metadata and controls

95 lines (80 loc) · 7.22 KB

Rayrun Bot 文档索引

本文件只做导航与约定,不复制项目状态、验收读数或版本号。 状态入口:../README.md 的 Status 段(中文镜像 ../README.zh-CN.md 的「状态」段)。 工程指令:../CLAUDE.md。

1. 真相源与入口

入口 负责什么
../README.md 产品页与状态;英文为准
../README.zh-CN.md 中文镜像,同一 commit 更新
00-product-direction.md 产品方向:定位、目标用户、v0.1 范围与产品决策
01-system-architecture.md 技术基线:分层、边界、信任模型
06-local-state.md 本地状态目录、机器布局、原子写与权限
07-security.md 安全目标与威胁模型
08-integration.md 依赖契约与 Rayrun 平台需求
09-deployment.md 安装、运行、配置与故障处理
plans/mvp-plan.md v0.1 范围、验收任务、工作分解
adr/architecture-decisions.md 未决架构决策与 ADR 登记
../CLAUDE.md 编码 agent 的工程指令;不放状态

2. 文档地图

分类 文档 负责什么
产品与方向 产品方向、路线图、FAQ 定位、目标用户、v0.1 范围、里程碑与用户常见问题
技术基线 系统架构、安全、本地状态 分层、边界、状态布局、威胁模型
Bot 与云端 Bot 模型、云端 bot runtime、审批 bot 定义、队列/session、审批语义
客户端与设计 客户端设计、UI 设计、Bot 人格、桌面发行版、mockups 表面、RPC、视觉规范、bot 身份、v1.0 桌面 B1/B2 方案
计划与验收 MVP 计划、客户端计划 v0.1 工作分解、客户端交付
平台集成 集成与平台需求 依赖契约、平台能力与优先级
部署与操作 部署与运行 安装、配置、检查、故障处理
调研 灵感 Grok Bot 等参考;不是真相源
决策 架构决策 ADR-001–ADR-016;只有 Decided 才算最终

00–09 是编号顶层文档;plans/、adr/、design/、research/ 放细节, mockups/ 放视觉素材。00/01 分别是产品与技术的第一真相源;其余编号文档是 各自领域的规范,状态仍回 README。

3. ADR 登记册

状态只取 Proposed / Decided;Open 表示还没有提案。本表只登记,决策细节、 证据和修订以 architecture-decisions.md 为准。 下一个可用编号:ADR-017。 编号一旦占用不再复用。

编号 标题 状态 文件
ADR-001 审批在哪里执行 Proposed architecture-decisions.md
ADR-002 所有权矩阵与单写者规则 Proposed architecture-decisions.md
ADR-003 基于 Rayrun 文件 API 的控制通道协议 Proposed architecture-decisions.md
ADR-004 与 dsh-rayrun-computer 的契约 Proposed architecture-decisions.md
ADR-005 副作用执行语义 Proposed architecture-decisions.md
ADR-006 “合上笔记本”意味着什么 Proposed architecture-decisions.md
ADR-007 常驻 bot runtime 的凭据与 DSH profile 模型 Proposed architecture-decisions.md
ADR-008 Desktop 访问路径 Proposed architecture-decisions.md
ADR-009 Routines / scheduler 范围 Proposed architecture-decisions.md
ADR-010 RPC 路由与信封 Proposed architecture-decisions.md
ADR-011 审批 schema 与 canonical action hash Proposed architecture-decisions.md
ADR-012 恢复与运行语义 Proposed architecture-decisions.md
ADR-013 文档清理 Proposed architecture-decisions.md
ADR-014 桌面发行版与更新单元 Accepted(2026-11-21,B1) architecture-decisions.md
ADR-015 云端 bot runtime 层 Proposed(v0.1) architecture-decisions.md
ADR-016 本地 bot 控制面 Proposed(v0.1) architecture-decisions.md

先定 ADR-015/016,再定 ADR-001/002。 前者决定控制面/执行面的分层与权威,后者 决定审批的信任边界和产物所有权;在它们定下来之前,C/E 工作流不应动工。ADR-014 已定为 B1,属于 v1.0,不阻塞 v0.1。

4. 进行中的计划

本表只登记仍未收口的计划;完成度、验收证据和状态以各文件头与正文为准,本表不复制。

计划 未闭合项 详情
MVP 计划 A1–A12 验收、B/C/D/E 工作流 §2、§5、§6
客户端计划 C-S1–C-S6 spike 与客户端接线 Week 0、Delivery waves
集成与平台需求 会话/常驻 runtime、余额护栏 §3
架构决策 ADR-001–ADR-016 本文 §3

5. 文档约定

  • 真相源优先级:产品方向 → 00-product-direction.md;产品状态 → README.md; 技术基线 → 01-system-architecture.md;安全 → 07-security.md;范围与验收 → plans/mvp-plan.md;未决架构 → adr/architecture-decisions.md;导航 → 本文件。 文档冲突时按此顺序回落。
  • 分类:plans/ 记“为什么这么做、怎么做”;adr/ 记不可轻易逆转的决策; design/ 记视觉、交互与人格;research/ 是调研材料,不是真相源; 09-deployment.md 记“怎么跑起来”。
  • 语言:产品 README 英文为准并维护中文镜像;docs/ 新文档用中文,历史英文 文档在重写时翻译;代码、注释、接口命名和提交信息用英文。
  • 新增文档:先在本文件 §2 加一行;新增决策在 §3 加一行,并把“下一个可用编号” 加一;新增未收口计划在 §4 加一行。
  • 链接:Markdown 链接必须可解析;相对链接以本文件所在目录为基准。
  • 本文件不复制状态、验收读数或版本号;这些只出现在各自的真相源中。