LLM-driven documentation generation in Simplified Technical English (STE), specifically the 'check mode' functionality for reporting rule violations.
Raw Developer Origin & Technical Request
GitHub Issue
Jul 31, 2026
`references/checklist.md` points check mode at a `rules.md` that the package does not contain.
**Where**
`skills/simple-english/references/checklist.md`, in the "When reporting violations (check mode)" section:
> For each violation give: the rule number, the offending text, and a compliant rewrite. Cite only rule numbers that appear in rules.md.
**The problem**
The package ships `SKILL.md`, `references/checklist.md` and `references/use-cases.md`. There is no `rules.md`. The rule catalog lives in `SKILL.md`.
`SKILL.md` states the opposite, and explains why it matters:
> Cite only rule numbers that exist in this file. Do not cite rule numbers from memory: the numbering is unintuitive and models invent it (tested — an agent without this file cited "Rule 3.1: short sentences"; the real Rule 3.1 is about verb forms).
So an agent that follows the checklist is sent to a file it cannot read. It then either omits the citations or invents them, which is the failure `SKILL.md` warns about. `checklist.md` is also the path `SKILL.md` recommends for a full audit, so this is on the main route for check mode, not an edge case.
**Suggested fix**
Change the reference in `checklist.md` from `rules.md` to `SKILL.md`. Alternatively, split the catalog out into a real `rules.md` and have `SKILL.md` reference it.
**Context**
Found while adopting the skill in a monorepo and running it in check mode across seven documents. The citations came out correct only because `SKILL.md` was in conte...
Developer Debate & Comments
No active discussions extracted for this entry yet.
Adjacent Repository Pain Points
Other highly discussed features and pain points extracted from AminBlg/SimpleEnglish.
Frequently Asked Questions
Market intelligence mapped to LLM-driven documentation generation in Simplified Technical English (STE), specifically the 'check mode' functionality for reporting rule violations..
What problem does LLM-driven documentation generation in Simplified Technical English (STE), specifically the 'check mode' functionality for reporting rule violations. solve?
Which technical concepts are associated with LLM-driven documentation generation in Simplified Technical English (STE), specifically the 'check mode' functionality for reporting rule violations.?
Engagement Signals
Cross-Market Term Frequency
Quantifies the cross-market adoption of foundational terms like audit and SKILL.md by tracking occurrence frequency across active SaaS architectures and enterprise developer debates.
SaaS Metrics