用途
本页说明如何把项目已经信任的公开材料转成一个可复用的交接包:根目录 AGENTS.md 作为入口,.uai/ 文件按主题保存稳定上下文。目标是让新的 AI、维护者或供应商不依赖私聊记忆,也能从仓库本身理解项目。
最小交接包
AGENTS.md写明项目摘要、读取顺序、硬约束、当前工作、部署规则和不得触碰的边界。.uai/context.uai记录网站目的、受众、成功标准和当前公共承诺。.uai/stack.uai与.uai/architecture.uai记录运行环境、主题、插件、路由形状和系统边界。.uai/public-surface.uai记录读者和机器可以依赖的页面、接口、发现文件和语言覆盖范围。.uai/constraints.uai记录安全、法律、支持声明、发布和破坏性操作红线。.uai/progress.uai、.uai/decisions.uai、.uai/operations.uai与.uai/style.uai记录进展、决策、运行步骤和写作规范。
从网站说明生成
- 先收集网站目的、面向人群、产品承诺、文档入口、发布说明、路线图和运行手册。
- 把稳定事实拆到相应的
.uai文件,不把临时聊天记录当作项目事实。 - 把支持语言、公共路由、机器发现文件和禁用范围写清楚,避免把计划中的能力说成已经支持。
- 在
AGENTS.md中列出必须加载的.uai文件,并要求新 AI 在大范围修改前复述理解、确认硬约束、说明将触碰的文件或路由、列出检查。
UAIX 当前做法
本仓库已经按这个模式运行。根目录 AGENTS.md 是入口,.uai/ 是按主题拆分的上下文包;公开页面先指向本页,再指向 AGENTS.md 链接规范、报告 和 协议优化报告 获取更深背景。
支持边界
当前页面描述的是文件交接模式和人工可执行流程。不要把它描述为已经存在的 .uai 生成器、上传验证器、SDK、CLI、认证计划或背书服务;这些能力只有在公开工具、夹具和验证行为发布后才能成为支持声明。