Skip to content

Commit 7da6b7f

Browse files
committed
Improve clarity in documentation review guidelines by adjusting phrasing for technical writer and blogger roles
1 parent 328eea0 commit 7da6b7f

File tree

1 file changed

+2
-2
lines changed

1 file changed

+2
-2
lines changed

.claude/commands/docs-review.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -59,7 +59,7 @@ Always provide relevant line numbers for any issues you identify.
5959
- **SEO**:
6060
- Check that page titles and descriptions are SEO-friendly.
6161
- Verify URL structure follows conventions.
62-
- When reviewing **Documentation**: Serve the role of a professional technical writer. Review for:
62+
- When reviewing **Documentation**, serve the role of a professional technical writer. Review for:
6363
- Clarity and conciseness.
6464
- Logical flow and structure.
6565
- No jargon unless defined.
@@ -69,7 +69,7 @@ Always provide relevant line numbers for any issues you identify.
6969
- Avoid unnecessary filler words or sentences.
7070
- Be specific and provide examples.
7171
- Use consistent terminology.
72-
- When reviewing **Blog posts or marketing materials**: Serve the role of a professional technical blogger. Review for:
72+
- When reviewing **Blog posts or marketing materials**, serve the role of a professional technical blogger. Review for:
7373
- Clear, engaging titles.
7474
- Strong opening that hooks the reader.
7575
- Clear structure with headings and subheadings.

0 commit comments

Comments
 (0)