项目文档导航
SoftBox 软件盒子的 harness coding 文档集。agent 开始编程时以
00-ai-start-here.md为工作入口。
一句话定位
SoftBox 软件盒子是一个使用 Go + Gio 开发的 Windows 桌面客户端,为自家软件产品家族提供「发现 → 下载 → 安装 → 更新 → 启动 → 授权」的一站式安全闭环;第一版先跑通签名清单 → 下载安装 → 启动更新 → 机器绑定授权的 MVP,并提供现代版与 Win7 遗留版双构建。
文档导航
../AGENTS.md:AI coding agent 的仓库级入口(含硬性架构边界)。../CLAUDE.md:Claude Code 的薄入口,具体规则以AGENTS.md为准。../progress.md:可选历史归档 / 项目级大事记;执行记录默认写各任务文件的## 执行记录。- AI 开发入口:agent 每次开始工作的入口、阅读顺序和任务领取规则。
- 项目愿景:为什么做、为谁做、产品原则、非目标。
- 需求:要什么、用户故事、验收标准,不写技术实现。
- 技术栈:Go + Gio 双工具链矩阵、构建命令、依赖纪律。
- 架构设计:分层结构、monorepo 目录、数据模型、安全流程和开发顺序。
- 编码规则:AI 写代码前必须遵守的硬约束(分层、工具链、安全纪律)。
- 任务路线图:Phase 0-6 阶段划分、里程碑和待办池;只读,不跟踪单任务状态。
- 任务文件(默认):一任务一文件
docs/tasks/T-<编号>.md,单/多 agent 通用,每个 agent 同时只做一个。 - 已有项目接入清单:把本模板补进已有代码库时的迁移步骤(本项目从零开始,备查)。
- 协议合约:Catalog 清单、标准软件包协议 v1、许可证、事件合约、CLI 参数。
- 页面与视图结构:Gio 视图划分、组件归属、交互硬约束。
- 当前实现状态:可覆盖的当前快照,记录仓库现实状态、可运行命令和下一步可做任务。
- Agent 上下文清单 /
agent-context.json/Schema:按任务类型选择文档、用提交 / 文件 SHA 避免重复读取。 - Gitea MCP 接入:可选的共享文档、Issue / PR 协调、安全配置和断连降级规则(当前未启用)。
- Gitea 多 Agent 协作:可选的任务映射、串行分配、防重复 claim 和 PR 状态协议(当前未启用)。
- 收尾检查清单:会话结束前逐项检查,保证下一轮无需人工修复即可继续。
- 方法对照表:失败模式 → 首要修复 → 工件;出问题先查这里对症补工件。
- 评审评分表:单次会话输出的结构化评审。
- 质量文档:代码库长期健康度追踪。
../init.sh/../init.ps1:标准启动与验证入口脚本(根目录),统一安装、验证和启动命令。按操作系统二选一;T-001 完成前顶部三个命令为占位符,运行会主动失败。../scripts/validate_agent_context.py:零第三方依赖校验上下文清单、Schema 和仓库相对路径。../scripts/validate_harness_governance.py:离线检查导航、链接、任务、模板和敏感信息。../tests/test_governance.py:标准库治理回归测试。
任务 / 进度 / 当前状态
tasks/(docs/tasks/T-<编号>.md)维护任务:规格、依赖、状态(frontmatter)和执行记录,一任务一文件。06-tasks.md维护路线图:阶段划分、里程碑和待办池,不跟踪单任务状态。current-state.md维护当前快照:当前目录、当前可运行命令、任务摘要和下一个可领取任务。../progress.md可选:历史归档或项目级大事记,不逐任务追加。
维护原则
- 需求变化先改文档,再改代码。
- 代码现实变化后同步
current-state.md;任务长期状态和执行证据写进对应任务文件。 - 协议(manifest / app.json / 许可证)、数据模型、技术栈一旦在文档中定稿,代码不得另起一套。
- agent 开始新任务前,必须从
00-ai-start-here.md进入。