Skip to content

Commit 6682d41

Browse files
committed
docs(documentation): add bold anti-slop and punctuation requirements
- Explicitly call out no AI slop in documentation rules - Add bold hard requirements to documentation skill
1 parent 36f0ade commit 6682d41

2 files changed

Lines changed: 9 additions & 0 deletions

File tree

rules/810-documentation.mdc

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -234,6 +234,10 @@ docs/
234234
- Define technical terms
235235
- Use examples liberally
236236

237+
### Anti-Slop (Required)
238+
239+
**No AI slop.** Keep documentation concise, specific, and grounded. Prefer deleting filler over adding more text.
240+
237241
### Voice (Avoid "you/your")
238242

239243
Prefer **neutral** or **imperative** phrasing over second-person voice.

skills/documentation-standards/SKILL.md

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -12,6 +12,11 @@ description: Documentation best practices including Markdown formatting, Mermaid
1212
3. **Show, Don't Just Tell**: Use examples and diagrams
1313
4. **Consistent Format**: Follow established patterns
1414

15+
## Hard Requirements (Writing)
16+
17+
- **No AI slop** - remove filler, keep docs concrete and task-oriented
18+
- **No em dashes/en dashes** - use hyphens (`-`) instead
19+
1520
## Voice
1621

1722
Prefer neutral/imperative phrasing - avoid "you/your" in professional docs.

0 commit comments

Comments
 (0)