writing-guidelines

Featured

This skill should be used when the user asks to "review writing", "check documentation style", "audit interface copy", or "apply writing guidelines".

Code & Development 1,141 stars 108 forks Updated today Apache-2.0

Install

View on GitHub

Quality Score: 96/100

Stars 20%
100
Recency 20%
100
Frontmatter 20%
70
Documentation 15%
100
Issue Health 10%
50
License 10%
100
Description 5%
100

Skill Content

# Writing Guidelines Review the files or patterns provided by the user for compliance. Read files, check against rules below. Output concise but comprehensive: sacrifice grammar for brevity. High signal-to-noise. ## Rules ### Planning & content type - Every page has a plan (overview, goal, audience, content plan, open questions) referenced or linked - Content type declared in `meta.contentType`: `Tutorial`, `How-to`, `Reference`, `Conceptual`, `Troubleshooting`, or `Landing` - Title is user-shaped (the user's question), not feature-shaped (the engineer's name) - Page does one job: tutorial OR how-to OR reference, not three at once - Goal is verb-driven (Bloom's taxonomy): "configure", "explain", "debug" (testable) - Multi-audience pages: short shared opener, then technical subsections ### Voice & tone - Active voice. Mental test: append "by monkeys". If the sentence parses, rewrite - Direct address: `you`, never `the user` or `one can` - Imperative for steps: "Click **Add Project**", not "You will need to click **Add Project**" - Sentences under 20 words target - Contractions encouraged (`you'll`, `it's`) for warmth - Present tense unless describing future behavior - Limit `we`: only for deliberate organization actions ("we recommend", "we deprecated"), never as a stand-in for "you" - No rhetorical questions (sounds like marketing) - Second-read test: read each sentence once at speech pace; if you re-read to parse it, name the subject, the action, and the consequence (...

Details

Author
fcakyon
Repository
fcakyon/claude-codex-settings
Created
1 years ago
Last Updated
today
Language
Python
License
Apache-2.0

Integrates with

Similar Skills

Semantically similar based on skill content — not just same category