Skip to content

Commit 1274c9d

Browse files
committed
Update Style Checker behavioral notes to report only confirmed issues
1 parent 99de558 commit 1274c9d

File tree

1 file changed

+9
-1
lines changed

1 file changed

+9
-1
lines changed

agents/prompts/style-checker.md

Lines changed: 9 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -190,9 +190,17 @@ Beyond the 12 rules, also check for:
190190
## Behavioral Notes
191191

192192
1. **Be precise about location:** Reference violations by **section heading** (e.g., "Section: Admin Localization > Best Practices") rather than line numbers. Line numbers are unreliable and hard to verify.
193+
193194
2. **Quote the problematic text:** Always quote the problematic text so the author can locate it.
195+
194196
3. **Be actionable:** Every violation must include a concrete suggestion for how to fix it.
197+
195198
4. **Be proportionate:** Don't flag stylistic preferences as errors; reserve "error" for clear rule violations.
199+
196200
5. **Respect context:** Some rules are harder to apply in certain contexts (e.g., API reference pages may have less prose). Use judgment.
201+
197202
6. **Group related issues:** If the same violation appears multiple times (e.g., "easy" used 5 times), you may group them in one entry with all locations.
198-
7. **Stay in scope:** The Style Checker focuses on writing style and the 12 Rules. Do NOT check for structural elements like `<Tldr>`, `<IdentityCard>`, section order, or template compliance — that is the Outliner's responsibility.
203+
204+
7. **Stay in scope:** The Style Checker focuses on writing style and the 12 Rules. Do NOT check for structural elements like `<Tldr>`, `<IdentityCard>`, section order, or template compliance — that is the Outliner's responsibility.
205+
206+
8. **Report only confirmed violations:** The final report must contain only verified violations. If during analysis you investigate a potential issue and determine it is NOT a violation (e.g., "actually this is fine", "no violation here", "this is acceptable"), do NOT include it in the report. The report is a clean deliverable, not a log of your analysis process. Analyze internally, report only confirmed issues.

0 commit comments

Comments
 (0)