Writing Documentation

Produces concise, clear documentation by applying Elements of Style principles. Use when writing or improving any technical documentation (READMEs, guides, API docs, architecture docs). Not for code comments.

59 stars 10 forksWriting & Content

Install

skills CLI (Claude Code, Cursor, Codex and more)
npx skills add ratacat/claude-skills --skill writing-documentation
Manual install
git clone --depth 1 https://github.com/ratacat/claude-skills.git /tmp/claude-skills
mkdir -p ~/.claude/skills
cp -r /tmp/claude-skills/skills/writing-documentation ~/.claude/skills/writing-documentation

Personal skills live in ~/.claude/skills. Use .claude/skills in a project folder to share a skill with your team.

From the SKILL.md

# Writing Documentation Skill

Apply Strunk & White's *Elements of Style* principles to produce concise, clear technical documentation.

## When to Use This Skill

**Use this skill when:**
- Writing new documentation (README, API docs, guides, tutorials, architecture docs)
- Improving existing documentation
- Reviewing documentation for quality
- User asks to "make this more concise" or "improve clarity"
- User mentions: documentation, docs, README, guide, tutorial, API docs

**Do NOT use this skill for:**
- Code comments (different context, separate skill needed)
- Marketing copy (requires persuasive voice, not neutral clarity)
- Personal blog posts (requires individual voice)

## Workflows

### Workflow 1: Write New Documentation

**Steps:**

1. **Understand the purpose**
   - [ ] What is the primary goal of this documentation?
   - [ ] Who is the target audience?
   - [ ] What do readers need to accomplish after reading?

2. **Load writing principles**
   - [ ] Read `reference/strunk-white-principles.md` to internalize core principles

3. **Determine documentation type**
   - [ ] Read `reference/doc-types.md` to select appropriate type
   - [ ] Identify essential sections based on guidelines

4. **Draft the documentation**
   - [ ] Apply Strunk & White principles while writing

5. **Validate quality**
   - [ ] Run through Quality Checklist (below)
   - [ ] Verify all essential information is present
   - [ ] Confirm document achieves its purpose
Read the full skill on GitHub

Details

Skill name
writing-documentation
Path
skills/writing-documentation/SKILL.md
Repo updated
11 February 2026

FAQ

What does the Writing Documentation skill do?

Produces concise, clear documentation by applying Elements of Style principles. Use when writing or improving any technical documentation (READMEs, guides, API docs, architecture docs). Not for code comments.

How do I install the Writing Documentation skill?

skills CLI (Claude Code, Cursor, Codex and more): npx skills add ratacat/claude-skills --skill writing-documentation. Skills go in ~/.claude/skills (personal) or .claude/skills (project), and Claude loads them automatically when a task matches the description.

Is Writing Documentation popular?

It lives in ratacat/claude-skills, which has 59 GitHub stars and 10 forks.

Related skills

Skill Creator

59

ratacat/claude-skills

Guide for creating effective skills. This skill should be used when users want to create a new skill (or update an existing skill) that extends Codex's capabilities with specialized knowledge, workflows, or tool integrations.

Skill & Plugin Authoring10

Skill Installer

59

ratacat/claude-skills

Install Codex skills into $CODEX_HOME/skills from a curated list or a GitHub repo path. Use when a user asks to list installable skills, install a curated skill, or install a skill from another repo (including private repos).

Software Development10

Agent Browser

59

ratacat/claude-skills

Browser automation using Vercel's agent-browser CLI. Use when you need to interact with web pages, fill forms, take screenshots, or scrape data. Alternative to Playwright MCP - uses Bash commands with ref-based element selection. Triggers on "browse website", "fill form", "click button", "take screenshot", "scrape page", "web automation".

AI, LLMs & Agents10

Writing Skills

59

ratacat/claude-skills

Use when user asks to create, write, edit, or test a skill. Also use when documenting reusable techniques, patterns, or workflows for future Claude instances.

Writing & Content10

Ripgrep

59

ratacat/claude-skills

Use when searching text in files, codebases, books, or documents. Use when finding files by pattern, searching large files that are too big to read fully, extracting specific content from many files, or when grep/find is too slow. Triggers on "search for", "find occurrences", "look for pattern", "search in files".

Writing & Content10

Wordpress Publisher

51

aviz85/claude-skills-library

Publish posts to WordPress. Use for: publish blog post, upload to WordPress, פרסם בבלוג.

Writing & Content14

Browse the most popular Claude skills, all writing & content skills, or write your own with the skills generator.