可复用模板
模板帮助启动文档,不是必须填写的表单。先选择最有价值的部分,删除不适用章节,用项目实际名称、路径、配置和证据替换占位符。不要在公共模板中填入机器路径、凭据或真实客户信息。
AI 工作流
- AI 任务契约模板:给人类和 AI 编码代理明确目标、边界、授权、验收与验证。
AI 任务契约
每项非琐碎的代理任务都应明确目标、仓库/路径范围、验收条件、权威上下文、验证命令和本次授权。请填写 AI 任务契约模板,并遵守 AI 参与开发工作流。
项目和文档
- README 模板:项目用途、快速开始和入口。
- AGENTS 模板:短小的仓库工作规则和文档链接。
- 项目说明模板:目标、范围、需求和验收条件。
- 架构模板:边界、接口、数据、部署和风险。
- 文档索引模板:权威文件、状态和更新责任。
- ADR 模板:背景、选项、决定和后果。
- 功能计划模板:切片、验收、风险和发布顺序。
- 工程标准模板:标准覆盖和采用顺序。
- 项目地图模板:仓库、责任、文档和看板关系。
接口、数据、交付和运维
- 服务目录模板
- API 模板
- 数据模型模板
- 数据变更模板
- 租户边界模板
- 本地开发模板
- 配置模板
- 测试策略模板
- Runbook 模板
- 发布记录模板
- Issue 模板
- Pull Request 模板
- 协作交接模板
- 分享用项目登记模板
- 本机私有路径映射模板(此文件不应提交)
Docker Compose 样例
Compose 样例只是可改编的本地开发范例,不是生产配置或完整应用。使用前需要设置唯一 Compose 项目名、选择端口与私有环境值、添加实际应用 package 文件和所需数据库角色初始化方式,并解析最终 Compose 配置。