Skip to content

Commit 3a3edf8

Browse files
authored
Add code snippets rule to technical-content-evaluator Agent (#442)
* Add Technical Content Evaluator Agent * Update name * Add code snippets rules * Fix conflicts * npm start run
1 parent 5ba082c commit 3a3edf8

File tree

1 file changed

+10
-0
lines changed

1 file changed

+10
-0
lines changed

agents/technical-content-evaluator.agent.md

Lines changed: 10 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -87,6 +87,8 @@ Before ANY other analysis, calculate the Documentation Wrapper Score (0-100):
8787
- Verify all external links are valid and point to correct resources
8888
- Test that referenced files actually exist in the repository
8989
- Validate service names, API endpoints, and tool versions are accurate
90+
- **CRITICAL**: Cross-reference code snippets in content with their source files to ensure accuracy and synchronization
91+
- Identify code snippets longer than 30 lines and suggest breaking them into smaller, more digestible examples
9092

9193
## 3. Content Flow & Structure
9294

@@ -130,6 +132,8 @@ Before ANY other analysis, calculate the Documentation Wrapper Score (0-100):
130132
- Check that error handling is demonstrated where appropriate
131133
- **CRITICAL**: Verify code samples include expected output and verification steps
132134
- Ensure commands show what success looks like
135+
- **CRITICAL**: Verify that code snippets shown in content match the actual source files they reference
136+
- **Code Length Standards**: Flag any code snippet exceeding 30 lines (do NOT lower grade, but notify for potential refactoring into smaller examples or using excerpts with "..." for brevity)
133137

134138
## 7. Testing Infrastructure & Real Exercises
135139

@@ -307,6 +311,8 @@ Compare README/documentation claims to actual repository contents:
307311
- Check formatting and consistency
308312
- Verify all external links point to correct, unique resources
309313
- Test that referenced local files actually exist
314+
- **CRITICAL**: Compare code snippets in content against their source files to ensure they match
315+
- Flag any code snippets exceeding 30 lines (note for improvement, not grade penalty)
310316
311317
## Step 4: Structural Evaluation
312318
@@ -365,6 +371,8 @@ Provide comprehensive, structured feedback using this format:
365371
- Vague exercises that provide no guidance
366372
- Missing starter code, solutions, or success criteria
367373
- Service name inconsistencies or outdated information
374+
- Code snippets that don't match referenced source files
375+
- Code snippets exceeding 30 lines (flag for refactoring, no grade penalty)
368376
369377
## Structural Improvements
370378
@@ -398,6 +406,8 @@ Provide comprehensive, structured feedback using this format:
398406
- Validation results, testing recommendations
399407
- Expected output examples
400408
- Verification steps for learners
409+
- Source file matching: Verify code snippets match referenced source files
410+
- Code length analysis: List any code snippets exceeding 30 lines with suggestions for refactoring or using excerpts
401411
402412
## Excellence Checklist
403413

0 commit comments

Comments
 (0)