Define repository and feature-scoped documentation rules for PRDs, User Stories, logic, UI, technical design, and progress evidence. Move feature-owned documents under docs/features, add one entry point per feature, remove the redundant docs index, and update all affected cross-references. Expand the local tool environment design with explicit product, story, logic, UI, technical, and progress documents.
40 lines
2.0 KiB
Markdown
40 lines
2.0 KiB
Markdown
# 本机工具环境
|
|
|
|
本目录是 GoodBuddy“本机工具环境”功能的唯一文档入口。该功能为本机 SKILL 和本机
|
|
stdio MCP 提供明确、可诊断的 Node.js 与 Python 环境,同时允许专业用户选择自己维护的
|
|
解释器。
|
|
|
|
本功能不作用于 SSH Host 上的 GoodBuddy Agent、固定 Node、签名 Runtime、SKILL 或 MCP。
|
|
|
|
## 文档导航
|
|
|
|
| 文档 | 权威职责 |
|
|
| --- | --- |
|
|
| [PRD](./prd.md) | 用户问题、产品目标、范围、需求和产品验收 |
|
|
| [User Stories](./user-stories.md) | 用户角色、使用场景和逐故事验收 |
|
|
| [功能逻辑](./logic-design.md) | 不变量、状态机、决策表、失败恢复和跨场景一致性 |
|
|
| [UI 设计](./ui-design.md) | 页面结构、组件、状态、文案和无障碍一致性 |
|
|
| [技术设计](./technical-design.md) | Main、Runtime、MCP、打包、生命周期和测试架构 |
|
|
| [功能进度](./progress.md) | 已完成、进行中、待实施、阻塞项和验证证据 |
|
|
|
|
## 术语
|
|
|
|
| 术语 | 定义 |
|
|
| --- | --- |
|
|
| 本机工具环境 | GoodBuddy 在桌面所在设备上向本机 Runtime 和 stdio MCP 提供的工具命令环境 |
|
|
| GoodBuddy 托管 | 由 GoodBuddy 提供、验证并解析的 Node.js 或 Python |
|
|
| 自定义环境 | 用户从检测结果中选择或直接指定的外部解释器 |
|
|
| 工具就绪 | 解释器及配套命令通过真实诊断 |
|
|
| 能力依赖就绪 | 某个 SKILL 或 MCP 所需的第三方包和入口通过实际验证 |
|
|
|
|
## 文档维护规则
|
|
|
|
1. 产品范围只在 PRD 定义,其他文档链接引用。
|
|
2. 界面视觉和交互只在 UI 设计定义,并服从仓库根目录的
|
|
[统一界面设计系统](../../../UI-DESIGN.md)。
|
|
3. 状态转换、优先级和冲突决策只在功能逻辑中定义。
|
|
4. 进度文档只记录已验证事实,不复制未来设计。
|
|
5. 技术实现变化先更新技术设计;用户行为变化同时更新 PRD、User Stories、功能逻辑和
|
|
UI 设计。
|
|
6. 每次完成功能阶段后立即更新进度、验证命令和剩余阻塞项。
|