# harness-template

**Repository Path**: qazll/harness-template

## Basic Information

- **Project Name**: harness-template
- **Description**: No description available
- **Primary Language**: Unknown
- **License**: Not specified
- **Default Branch**: master
- **Homepage**: None
- **GVP Project**: No

## Statistics

- **Stars**: 0
- **Forks**: 0
- **Created**: 2026-08-08
- **Last Updated**: 2026-08-08

## Categories & Tags

**Categories**: Uncategorized

**Tags**: None

## README

# Harness Pro - Harness Engineering 工程骨架示例

> 开箱即用的 Harness Engineering 项目骨架，基于 OpenAI 原始实践与社区最佳实践整理。

---

## 这是什么？

这是一个遵循 **Harness Engineering** 方法论的工程骨架项目。你可以直接复制此结构作为新项目的起点，也可以根据自己的需求进行调整。

### Harness Engineering 的核心理念

1. **AGENTS.md 是入口**：为 AI Agent 提供"地图"，而不是塞满细节的"百科全书"
2. **SSOT（单一可信来源）**：所有工程规范收敛到 `.harness/engineering-harness.md`
3. **机械化门禁**：质量要求通过脚本强制执行，不靠"自觉"
4. **ADR 记录决策**：重要技术决策通过 Architecture Decision Records 沉淀
5. **渐进式披露**：文档按需查阅，避免信息过载

---

## 快速开始

### 1. 了解结构

阅读 `AGENTS.md` 是 **第一步**，无论你是 AI Agent 还是人类开发者。

### 2. 运行门禁检查

**Windows（PowerShell）：**
```powershell
.\.harness\scripts\engineering-check.ps1
```

**Linux / macOS：**
```bash
bash .harness/scripts/engineering-check.sh
```

### 3. 逐步完善

随着项目推进，你需要：

- 编写新功能前，在 `.harness/features/INDEX.md` 登记
- 做技术选型时，新增 `.harness/adr/NNNN-xxx.md` 记录
- 保持 `docs/` 下文档与代码同步更新
- 定制化 `.harness/baseline.json` 中的门禁阈值

---

## 目录结构

```
your-project/
├── AGENTS.md                 # 【必选】Agent 导航入口和行为总纲
├── README.md                 # 本文件：项目说明
├── .harness/                 # 【核心】Harness 工程配置与治理
│   ├── config.json           # Harness 主配置
│   ├── baseline.json         # 基线配置（门禁阈值）
│   ├── engineering-harness.md # 【SSOT】工程规范总纲
│   ├── adr/                  # 架构决策记录
│   ├── features/INDEX.md     # 功能模块索引
│   └── scripts/              # 门禁检查脚本
├── docs/                     # 详细文档（按需查阅）
│   ├── architecture.md       # 系统架构
│   ├── design.md             # 设计文档
│   ├── testing.md            # 测试策略
│   ├── security.md           # 安全规范
│   ├── pitfalls.md           # 常见坑与避坑指南
│   ├── design-docs/          # 详细设计文档
│   ├── exec-plans/           # 执行计划
│   └── product-specs/        # 产品规格说明
├── skills/                   # Skill 定义（可复用的操作流程）
│   └── pre-review/SKILL.md   # 示例：代码预审 Skill
├── scripts/                  # 项目级工具脚本
└── .github/                  # GitHub 配置（PR 模板等）
```

---

## 文档导航

| 你想了解什么 | 去看什么 |
|---|---|
| AI Agent 工作规则 | `AGENTS.md` |
| 所有工程规范的最终依据 | `.harness/engineering-harness.md` |
| 系统架构设计 | `docs/architecture.md` |
| 代码怎么写 | `.harness/engineering-harness.md §3` + `docs/design.md` |
| 测试怎么写 | `docs/testing.md` |
| 安全要求 | `docs/security.md` |
| 历史技术决策及原因 | `.harness/adr/` |
| 项目有哪些功能模块 | `.harness/features/INDEX.md` |
| 这项目谁踩过什么坑 | `docs/pitfalls.md` |

---

## License

本骨架项目按 MIT License 免费使用，你可以在任何项目中使用、修改、分发。