Docs

Generate, audit, or update project documentation to a professional open-source standard. Use this skill whenever the user mentions docs, documentation, README, API reference, guides, migration guides, troubleshooting, llms.txt, doc audit, or wants to improve any written developer-facing content in a repository. Also trigger when the user says things like "document this", "write docs for", "update the docs", "our docs need work", or compares documentation quality to other projects. Covers Ruby (YARD), TypeScript (TSDoc/JSDoc), Markdown guides, configuration references, and doc site structure.

48 stars 7 forksWriting & Content

Install

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

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

From the SKILL.md

# Documentation Skill

Generate and maintain documentation that meets or exceeds the standard set by the best open-source Rails/JS projects (Inertia Rails, Vite Ruby, Rails itself).

## Before You Start

Read these reference files (located in the `references/` subdirectory next to this SKILL.md file) before proceeding:

1. **Quality Standard** — `references/quality-standard.md` — tiered audit checklist (Must-Have / Expected / Differentiator)
2. **Documentation Templates** — `references/templates.md` — structural skeletons for each doc type
3. **Competitive Landscape** — `references/competitive-landscape.md` — benchmarks against peer projects

## Workflow

### Step 1: Assess the current state

- Scan the repo for existing docs: `docs/`, `README.md`, `CHANGELOG.md`, `CONTRIBUTING.md`, inline code comments, Wiki, and any hosted doc site config (VitePress, Docusaurus, Jekyll, etc.)
- Identify what exists, what is outdated, and what is missing
- Compare against the Quality Standard reference above

### Step 2: Determine scope

If the user gave a specific target (e.g., `/docs $ARGUMENTS`), focus there. Otherwise, present a prioritized gap analysis:

1. **Critical gaps** - Missing README sections, no quick start, no API reference
2. **High-value improvements** - Outdated guides, missing migration/upgrade docs, no troubleshooting
3. **Polish** - LLMs.txt, cookbook/recipes, configuration reference, contributor guide improvements
Read the full skill on GitHub

Details

Skill name
docs
Path
skills/docs/SKILL.md
Repo updated
11 July 2026

FAQ

What does the Docs skill do?

Generate, audit, or update project documentation to a professional open-source standard. Use this skill whenever the user mentions docs, documentation, README, API reference, guides, migration guides, troubleshooting, llms.txt, doc audit, or wants to improve any written developer-facing content in a repository. Also trigger when the user says things like "document this", "write docs for", "update the docs", "our docs need work", or compares documentation quality to other projects. Covers Ruby (YARD), TypeScript (TSDoc/JSDoc), Markdown guides, configuration references, and doc site structure.

How do I install the Docs skill?

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

Is Docs popular?

It lives in shakacode/claude-code-commands-skills-agents, which has 48 GitHub stars and 7 forks.

Related skills

Immersive Reading

49

ryannli/immersive-reading

Turn long-form source material into bespoke interactive learning spaces. Use when the user wants to convert a blog post, essay, transcript, note, paper, or other long content into a polished static reader with chapters, sections, quotes, search, highlights, notes, optional bilingual support, light/dark mode, and source attribution.

Writing & Content

Partner One Pager

43

coolhawk2827-259f3/partner-one-pager

Write partner/channel one-pagers: mutual value, motion, requirements, next step. Triggers: partner one-pager, channel brief, alliance one-pager, 合作一页纸, 渠道简报. 中文:合作/渠道一页纸(共赢、合作方式、条件、下一步)。触发词:合作简报、渠道一页纸。

Writing & Content18

Linkedin Review

45

TrainWithShubham/skills

Review a LinkedIn profile like a recruiter, a career coach, and LinkedIn's own ranking algorithm together — produce a Recruiter Verdict (FOUND & CLICKED / FOUND, PASSED / NOT FOUND), a 100-point score across 6 dimensions, an estimated SSI (Social Selling Index) score with the candor that SSI is a self-diagnostic not a recruiter-visible signal, a 7 Deadly LinkedIn Sins check, highlights/lowlights, a full Headline rewrite (using a named formula — Belcak / Jeff Su / Justin Welsh), a full About rewrite (hook-optimized for the ~200-char mobile / ~300-char desktop "See more" fold), before→after expe

Writing & Content81

Crucible Writer

61

forsonny/The-Crucible-Writing-System-For-Claude

First-draft writing assistant for Crucible-planned novels. Use when author has completed planning (crucible-planner) and outlining (crucible-outliner) and wants to write the actual prose. Handles scene-by-scene drafting, style matching, continuity tracking, and hallucination prevention. Triggers on "write my novel," "draft chapter X," "start writing from my outline," "help me write my book," or when user has Crucible outline and wants prose output. Works with any Crucible-planned story.

Writing & Content21

Waterfall Enrich Contacts

81

TomGranot/hubspot-admin-skills

Enrich HubSpot contacts (email, phone, job title) through an external enrichment provider and write results back safely. Pluggable provider adapters with FullEnrich waterfall enrichment as the default; Apollo, Hunter, and Dropcontact included; bring your own via a template.

Writing & ContentIn 1 list19

Crucible Planner

61

forsonny/The-Crucible-Writing-System-For-Claude

Interactive planning system for epic fantasy novels using the Crucible Structure—a 36-beat narrative framework with three interwoven story strands (Quest, Fire, Constellation), five Forge Points, and a Mercy Engine. Use when user wants to plan a fantasy novel, provides a story premise/synopsis, asks to "plan my fantasy book," wants to create planning documents for an epic fantasy, or mentions the Crucible Structure. Guides users through multi-choice questions to generate 7 planning document categories (14 files total) from a simple premise.

Writing & Content21

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