|
| 1 | +# EDD Components vs Internal Evaluation Systems - Usage Guide |
| 2 | + |
| 3 | +## Overview |
| 4 | + |
| 5 | +This repository contains **two separate evaluation systems** with different purposes. Understanding when to use each is crucial for proper implementation. |
| 6 | + |
| 7 | +--- |
| 8 | + |
| 9 | +## 📋 **Internal Evaluation System** (`evals/configs/`) |
| 10 | + |
| 11 | +### Purpose |
| 12 | +- **Evaluates the quality of the prompt templates** in this repository |
| 13 | +- Tests whether `spec-prompt.txt`, `plan-prompt.txt`, `arch-prompt.txt`, etc. generate good outputs |
| 14 | +- **Quality assurance for the toolkit itself** |
| 15 | + |
| 16 | +### Structure |
| 17 | +``` |
| 18 | +evals/ |
| 19 | +├── configs/ |
| 20 | +│ ├── promptfooconfig.js # Main evaluation config |
| 21 | +│ ├── promptfooconfig-spec.js # Tests spec-prompt.txt quality |
| 22 | +│ ├── promptfooconfig-plan.js # Tests plan-prompt.txt quality |
| 23 | +│ ├── promptfooconfig-arch.js # Tests arch-prompt.txt quality |
| 24 | +│ ├── promptfooconfig-ext.js # Tests ext-prompt.txt quality |
| 25 | +│ └── promptfooconfig-clarify.js # Tests clarify-prompt.txt quality |
| 26 | +├── graders/ |
| 27 | +│ └── custom_graders.py # Custom graders for prompt quality |
| 28 | +└── prompts/ |
| 29 | + ├── spec-prompt.txt # The actual prompts being tested |
| 30 | + ├── plan-prompt.txt |
| 31 | + └── ... |
| 32 | +``` |
| 33 | + |
| 34 | +### When to Use |
| 35 | +- ✅ Testing if your prompt templates generate good specifications |
| 36 | +- ✅ Regression testing after modifying prompts |
| 37 | +- ✅ Quality assurance for the toolkit development |
| 38 | +- ✅ Ensuring prompts follow best practices |
| 39 | + |
| 40 | +--- |
| 41 | + |
| 42 | +## 🛡️ **EDD Components** (`evals/edd-components/`) |
| 43 | + |
| 44 | +### Purpose |
| 45 | +- **Framework for evaluating external projects** that use this toolkit |
| 46 | +- Security baseline checks, compliance validation, etc. |
| 47 | +- **Methodology for others to implement in their projects** |
| 48 | + |
| 49 | +### Structure |
| 50 | +``` |
| 51 | +evals/ |
| 52 | +├── edd-components/ |
| 53 | +│ ├── graders/ |
| 54 | +│ │ ├── check_pii_leakage.py # Security grader |
| 55 | +│ │ ├── check_prompt_injection.py # Security grader |
| 56 | +│ │ ├── check_hallucination.py # Security grader |
| 57 | +│ │ ├── check_misinformation.py # Security grader |
| 58 | +│ │ ├── check_regulatory_compliance.py # Compliance grader |
| 59 | +│ │ └── check_context_adherence.py # Context grader |
| 60 | +│ ├── configs/ |
| 61 | +│ │ ├── config.js # EDD example config |
| 62 | +│ │ ├── config-tier1.js # Tier 1 (fast) evaluations |
| 63 | +│ │ └── config-tier2.js # Tier 2 (semantic) evaluations |
| 64 | +│ └── goldset/ |
| 65 | +│ └── goldset.csv # Reference test data |
| 66 | +└── scripts/ |
| 67 | + ├── edd_failure_routing.py # EDD failure routing |
| 68 | + └── audit_binary_compliance.py # EDD compliance audit |
| 69 | +``` |
| 70 | + |
| 71 | +### When to Use |
| 72 | +- ✅ **External teams** implementing this toolkit in their projects |
| 73 | +- ✅ Evaluating **AI systems built using the prompts** from this toolkit |
| 74 | +- ✅ Security baseline validation for production AI systems |
| 75 | +- ✅ Compliance checking for regulated industries |
| 76 | + |
| 77 | +--- |
| 78 | + |
| 79 | +## 🔄 **Command Alignment Across Extensions** |
| 80 | + |
| 81 | +All extensions in Spec Kit follow a consistent workflow pattern: |
| 82 | + |
| 83 | +| Step | `/architect.*` | `/levelup.*` | `/evals.*` | Purpose | |
| 84 | +|------|---------------|--------------|-----------|---------| |
| 85 | +| **1. Initialize** | `/architect.init` | — | `/evals.init` | Reverse-engineer from existing codebase (brownfield) | |
| 86 | +| **2. Specify** | `/architect.specify` | `/levelup.specify` | `/evals.specify` | Extract core artifacts (ADRs, CDRs, eval criteria) from spec | |
| 87 | +| **3. Clarify** | `/architect.clarify` | `/levelup.clarify` | `/evals.clarify` | Resolve ambiguities through interactive questions | |
| 88 | +| **4. Implement** | `/architect.implement` | `/levelup.implement` | `/evals.implement` | Generate final outputs (AD.md, skills, PromptFoo config) | |
| 89 | +| **5. Validate** | `/architect.validate` | — | `/evals.validate` | Validate alignment/quality (READ-ONLY for architect) | |
| 90 | +| **6. Analyze/Trace** | `/architect.analyze` | `/levelup.trace` | `/evals.trace` | Post-implementation analysis and reporting | |
| 91 | + |
| 92 | +### Pattern Summary |
| 93 | + |
| 94 | +**Common workflow**: |
| 95 | +1. **init** (optional, brownfield only) → |
| 96 | +2. **specify** (extract) → |
| 97 | +3. **clarify** (refine) → |
| 98 | +4. **implement** (generate) → |
| 99 | +5. **validate/trace** (verify/analyze) |
| 100 | + |
| 101 | +**Key differences**: |
| 102 | +- **`/architect.*`**: Focuses on architectural decisions (ADRs → AD.md) |
| 103 | +- **`/levelup.*`**: Focuses on coding directives (CDRs → skills → team-ai-directives) |
| 104 | +- **`/evals.*`**: Focuses on evaluation criteria (goldset → PromptFoo config → test results) |
0 commit comments