Content
50%Weight 40%Scale 1-5Reviews the quality of instructions and guidance provided to agents. Good implementation is clear, handles edge cases, and produces reliable results.
The technical core (features, examples, CLI table, formatting rules) is concrete and actionable, but it is buried under substantial generic template boilerplate and duplicated validation sections, and the referenced script files are missing from the bundle. Workflow validation remains implicit rather than command-level.
Suggestions
Remove the generic boilerplate sections (When Not to Use, Required Inputs, Recommended Workflow, Output Contract, Validation and Safety Rules, Failure Handling, Input Validation, Deterministic Output Rules, Completion Checklist) or replace them with text-formatting-specific guidance; merge the duplicated 'Validation Shortcut' and 'Quick Validation' sections.
Provide the referenced bundle files (scripts/init_run.py, scripts/text_formatter.py) so the documented commands and the `from scripts.text_formatter import ...` example are actually executable, or reword references to match what is bundled.
Add a concrete validation checkpoint to the formatting workflow (e.g. run with --preview, diff against input, then write output) as an explicit validate-fix-retry loop rather than generic 'run a final validation pass' language.
| Dimension | Reasoning | Score |
|---|---|---|
Conciseness | Roughly ten generic boilerplate sections ('When Not to Use', 'Required Inputs', 'Recommended Workflow', 'Output Contract', 'Validation and Safety Rules', 'Failure Handling', 'Input Validation', 'Quick Validation', 'Deterministic Output Rules', 'Completion Checklist') are template filler unrelated to text formatting, e.g. 'Do not fabricate measurements, references, findings, or conclusions'. | 2 / 5 |
Actionability | Provides concrete executable code (TextFormatter/FormatOptions programmatic example), specific CLI commands with flags, and a parameter table, but the referenced scripts (scripts/init_run.py, scripts/text_formatter) are not present in the bundle so commands cannot actually run as-is. | 4 / 5 |
Workflow Clarity | A sequence and a preview safety flag exist, but validation checkpoints are generic boilerplate ('Run a final validation pass') rather than concrete commands; given this rewrites/batch-processes files, the missing explicit validate-fix-retry loop caps the score at 3. | 3 / 5 |
Progressive Disclosure | Sections are well-headed, but all content is inline with no reference files, the referenced scripts/ bundle is absent (broken references), and the 'Validation Shortcut' and 'Quick Validation' sections duplicate the same --help command. | 3 / 5 |
Total | 12 / 20 Passed |