Creating Documentation

Create and review README files and repository documentation that follows best practices for clarity, accessibility, and discoverability. Use when a user asks to create a README, write project documentation, improve existing documentation, add a CONTRIBUTING guide, review documentation for accessibility, or document a new repository.

23 stars 2 forksWriting & Content

Install

skills CLI (Claude Code, Cursor, Codex and more)
npx skills add willvelida/code-minions --skill creating-documentation
Manual install
git clone --depth 1 https://github.com/willvelida/code-minions.git /tmp/code-minions
mkdir -p ~/.claude/skills
cp -r /tmp/code-minions/packages/creating-documentation/skills/creating-documentation ~/.claude/skills/creating-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

# Creating Documentation

## Overview

This skill provides capabilities for creating and reviewing README files and other repository documentation that follows established best practices for structure, accessibility, and user experience.

Good documentation is the front door to your project. It helps users understand what your project does, how to use it, and how to contribute. This skill ensures documentation is clear, accessible, and follows industry standards.

## Capabilities

| Capability | Action | Description |
|------------|--------|-------------|
| Create README | `actions/create-readme.md` | Generate a comprehensive README for a repository |
| Create CONTRIBUTING | `actions/create-contributing.md` | Generate contribution guidelines |
| Review | `actions/review-documentation.md` | Analyse existing documentation for quality and accessibility |

## Standards

This skill bundles the following standards in `standards/`:

| Standard | File | Description |
|----------|------|-------------|
| README Structure | `readme-structure.md` | Essential sections and organization for README files |
| Accessibility | `accessibility.md` | Accessibility requirements for inclusive documentation |
| Writing Style | `writing-style.md` | Plain language and readability guidelines |
| Markdown | `markdown.md` | Markdown formatting best practices |
| Checklist | `checklist.md` | Consolidated compliance and quality checklist |

## Principles

### 1. Audience First
Read the full skill on GitHub

Details

Skill name
creating-documentation
Path
packages/creating-documentation/skills/creating-documentation/SKILL.md
License
Apache-2.0
Repo updated
11 June 2026

FAQ

What does the Creating Documentation skill do?

Create and review README files and repository documentation that follows best practices for clarity, accessibility, and discoverability. Use when a user asks to create a README, write project documentation, improve existing documentation, add a CONTRIBUTING guide, review documentation for accessibility, or document a new repository.

How do I install the Creating Documentation skill?

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

Is Creating Documentation popular?

It lives in willvelida/code-minions, which has 23 GitHub stars and 2 forks.

Related skills

Creating Agent Skill

23

willvelida/code-minions

Create and review Agent Skills that follow the open Agent Skills specification and best practices. Use when a user asks to create a new skill, build skill instructions, generate a SKILL.md file, review an existing skill for compliance, or improve skill quality. Covers skill structure, naming conventions, progressive disclosure, writing effective descriptions, creating actions and standards, and validation.

AI, LLMs & Agents

Creating Agents

23

willvelida/code-minions

Create and review agent definition files (agents.md) that give AI coding agents a clear persona, project knowledge, executable commands, code style examples, and explicit boundaries. Use when a user asks to create an agent, define an agent persona, write an agents.md file, set up a custom Copilot agent, review an existing agent definition, or improve agent quality. Covers the six core areas: commands, testing, project structure, code style, git workflow, and boundaries.

AI, LLMs & Agents

Creating Devcontainers

23

willvelida/code-minions

Create and review DevContainer configurations that follow organisational standards. Use when a user asks to set up a dev container, configure a development environment, create a devcontainer.json, add lifecycle hooks, review an existing DevContainer for compliance, or improve container security. Covers base images, features, extensions, lifecycle hooks, and security hardening.

Security

Enrich Knowledge Graph

23

Merit-Systems/agentcash-skills

Enrich people in a knowledge graph or wiki with contact and social media information — LinkedIn, email, phone, Twitter/X — using premium enrichment APIs via the agentcash CLI. Use this skill when the user wants to enrich contacts, find someone's LinkedIn or email, fill in missing contact info for people in their wiki or knowledge base, or says 'enrich', 'find contact info', 'look up LinkedIn', 'fill in missing info', or anything about augmenting people/contact pages with external data.

Writing & Content23

Write Vignette

45

pjt222/agent-almanac

Create R package vignettes using R Markdown or Quarto. Covers vignette setup, YAML configuration, code chunk options, building and testing, and CRAN requirements for vignettes. Use when adding a Getting Started tutorial, documenting complex workflows spanning multiple functions, creating domain-specific guides, or when CRAN submission requires user-facing documentation beyond function help pages.

Writing & ContentIn 1 list

Social Intelligence

23

Merit-Systems/agentcash-skills

Search and monitor Reddit using x402-protected APIs. USE FOR: - Searching Reddit posts and discussions - Getting comments from Reddit threads - Social media monitoring and research TRIGGERS: - "reddit", "subreddit", "reddit discussion" - "what are people saying", "social media", "sentiment" - "trending", "viral", "popular posts" Use agentcash.fetch for Reddit endpoints. Reddit $0.02/call. IMPORTANT: Use exact endpoint paths from the Quick Reference table below.

Writing & Content23

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