You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: agents/technical-content-evaluator.agent.md
+10Lines changed: 10 additions & 0 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -87,6 +87,8 @@ Before ANY other analysis, calculate the Documentation Wrapper Score (0-100):
87
87
- Verify all external links are valid and point to correct resources
88
88
- Test that referenced files actually exist in the repository
89
89
- 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
90
92
91
93
## 3. Content Flow & Structure
92
94
@@ -130,6 +132,8 @@ Before ANY other analysis, calculate the Documentation Wrapper Score (0-100):
130
132
- Check that error handling is demonstrated where appropriate
131
133
-**CRITICAL**: Verify code samples include expected output and verification steps
132
134
- 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)
133
137
134
138
## 7. Testing Infrastructure & Real Exercises
135
139
@@ -307,6 +311,8 @@ Compare README/documentation claims to actual repository contents:
307
311
- Check formatting and consistency
308
312
- Verify all external links point to correct, unique resources
309
313
- 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)
310
316
311
317
## Step 4: Structural Evaluation
312
318
@@ -365,6 +371,8 @@ Provide comprehensive, structured feedback using this format:
365
371
- Vague exercises that provide no guidance
366
372
- Missing starter code, solutions, or success criteria
367
373
- 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)
368
376
369
377
## Structural Improvements
370
378
@@ -398,6 +406,8 @@ Provide comprehensive, structured feedback using this format:
0 commit comments