Shpigford

Readme — Documentation skill for Claude Code

Documentation community intermediate

Generate comprehensive project documentation.

How to install Readme

This entry records only its repository, not the path inside it, so there is no exact command to give. Open Shpigford/skills and copy the folder into ~/.claude/skills/, or the file into ~/.claude/agents/.

What Readme does

Generate comprehensive project documentation.

One of 2 entries listed from Shpigford/skills. The repository README describes the whole collection, not this skill — read it on GitHub.

Alternatives in Documentation

  • Doc Co-authoring — Guide users through structured workflow for co-authoring documentation 94.1k ★
  • Context7 — claude-plugins-official Up-to-date library documentation lookup 50.1k ★
  • Notion Research Documentation — Research Notion content and synthesize findings into structured briefs 14.6k ★

Repository README

This is the README for Shpigford/skills, shared by 2 entries in this directory. It describes the repository, not this entry specifically.

Skills

Agent Skills for AI coding assistants. These skills follow the [Agent Skills Standard](https://github.com/anthropics/agent-skills-standard) and work with Claude Code, Cursor, Gemini Code Assist, GitHub Copilot, and other compatible tools.

Installation

npx skills add Shpigford/skills

Or manually:

git clone https://github.com/Shpigford/skills.git ~/.skills/shpigford

Available Skills

Skill Description
build Feature development pipeline - research, plan, track, implement
chat-widget Build real-time support chat with floating widget
conductor-setup Configure Rails projects for Conductor
favicon Generate favicon sets from source images
feature-image Generate branded social media images for feature announcements
issues Create, list, and view GitHub issues
new-rails-project Create opinionated Rails 8 + React projects
readme Generate comprehensive project documentation
screenshots Generate marketing screenshots with Playwright

readme

Creates comprehensive README.md documentation for projects. Performs deep codebase exploration before writing, covering:

  • Local development setup (step-by-step)
  • Architecture overview with directory structure and data flow
  • Environment variables reference
  • Deployment instructions (auto-detects platform)
  • Troubleshooting common issues

**Triggers:** "write readme", "create readme", "document this project", "project documentation"

**Example usage:**

Write a readme for this project

build

Feature development pipeline for building major features. Manages a 4-phase workflow:

  1. Research - Deep exploration of a feature idea
  2. Implementation - Create phased implementation plan
  3. Progress - Set up progress tracking

...