writing-guidelines

Installation
SKILL.md

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

Installs
1
GitHub Stars
1.1K
First Seen
11 days ago
writing-guidelines — fcakyon/claude-codex-settings