write-readme — write-readme install write-readme, structcms, community, write-readme install, ide skills, write-readme for developers, effective README files, Claude Code, Cursor, Windsurf

v1.0.0
GitHub

About this Skill

Perfect for Developer Agents needing high-quality README file generation for package or app documentation. write-readme is a skill that assists in creating README files, following a style guide that emphasizes referencing source files and avoiding code duplication.

Features

References source files instead of duplicating code
Supports inclusion of short setup snippets, such as .env examples and CLI commands
Follows a principle of describing architecture, purpose, and usage of packages or apps
Avoids duplicating full file contents in README files
Allows for exceptions, such as referencing lib/adapters.ts for adapter configuration
Enforces a rule of not updating READMEs unless the architecture itself changes

# Core Topics

write-readme install write-readme for developers effective README files
skrischer skrischer
[0]
[0]
Updated: 3/8/2026

Agent Capability Analysis

The write-readme skill by skrischer is an open-source community AI agent skill for Claude Code and other IDE workflows, helping agents execute tasks with better context, repeatability, and domain-specific guidance. Optimized for write-readme install, write-readme for developers, effective README files.

Ideal Agent Persona

Perfect for Developer Agents needing high-quality README file generation for package or app documentation.

Core Value

Empowers agents to create informative README files describing architecture, purpose, and usage, following a strict no-code-duplication principle and referencing source files like `lib/adapters.ts` for adapter configuration.

↓ Capabilities Granted for write-readme

Generating README files for new package releases
Automating documentation updates for app architecture changes
Creating setup snippets for .env files or CLI commands

! Prerequisites & Limits

  • Requires knowledge of project architecture and purpose
  • Should not duplicate source code
  • Limited to generating README files
Labs Demo

Browser Sandbox Environment

⚡️ Ready to unleash?

Experience this Agent in a zero-setup browser environment powered by WebContainers. No installation required.

Boot Container Sandbox

write-readme

Install write-readme, an AI agent skill for AI agent workflows and automation. Works with Claude Code, Cursor, and Windsurf with one-command setup.

SKILL.md
Readonly

README Style Guide

Principle

READMEs describe architecture, purpose, and how to use a package or app. They do not duplicate source code. Code changes should never require a README update unless the architecture itself changes.

Rules

No Code Duplication

  • Never copy full file contents into a README
  • Reference source files instead: "See lib/adapters.ts for the adapter configuration."
  • Exception: Short setup snippets (.env examples, CLI commands) that don't exist elsewhere

What Belongs in a README

  • Description & Purpose — What is this package/app and why does it exist?
  • Architecture Overview — High-level diagram or bullet points (changes rarely)
  • File Structure — Tree view with one-line comments per file (update when files are added/removed)
  • Setup Instructions — Concrete steps to get running (cp .env.example, pnpm install, pnpm dev)
  • Environment Variables — Required env vars with placeholder values
  • Key Concepts — Short prose explaining patterns and design decisions, with file references
  • Test Overview — One line per test file describing what it covers

What Does NOT Belong in a README

  • Full function implementations (they live in source files)
  • Complete type definitions (they live in source files)
  • Seed data contents (reference the seed file instead)
  • Detailed test step-by-step specifications (they live in the spec files)
  • Dependency version lists (they live in package.json)

File Structure Section

  • Must reflect the actual file system (keep in sync when adding/removing files)
  • Use tree format with inline # comments
  • Include all non-trivial files; skip generated files (.next/, node_modules/, *.tsbuildinfo)

Referencing Code

When explaining a concept, use this pattern:

Section definitions are created using `defineSection` from `@structcms/core`
and registered via `createRegistry`. See `lib/registry.ts` for the full setup.

Do not paste the contents of the referenced file into the README.

Language

  • README content is written in English
  • Keep sections concise — prefer short paragraphs and bullet points over long prose

Steps

  1. Read the existing README (if any) and the actual source files in the target directory
  2. Verify the file structure section matches the real file system
  3. Remove any code blocks that duplicate source files — replace with file references
  4. Ensure all required sections are present (Description, File Structure, Setup, Key Concepts)
  5. Verify all referenced files actually exist

FAQ & Installation Steps

These questions and steps mirror the structured data on this page for better search understanding.

? Frequently Asked Questions

What is write-readme?

Perfect for Developer Agents needing high-quality README file generation for package or app documentation. write-readme is a skill that assists in creating README files, following a style guide that emphasizes referencing source files and avoiding code duplication.

How do I install write-readme?

Run the command: npx killer-skills add skrischer/structcms/write-readme. It works with Cursor, Windsurf, VS Code, Claude Code, and 19+ other IDEs.

What are the use cases for write-readme?

Key use cases include: Generating README files for new package releases, Automating documentation updates for app architecture changes, Creating setup snippets for .env files or CLI commands.

Which IDEs are compatible with write-readme?

This skill is compatible with Cursor, Windsurf, VS Code, Trae, Claude Code, OpenClaw, Aider, Codex, OpenCode, Goose, Cline, Roo Code, Kiro, Augment Code, Continue, GitHub Copilot, Sourcegraph Cody, and Amazon Q Developer. Use the Killer-Skills CLI for universal one-command installation.

Are there any limitations for write-readme?

Requires knowledge of project architecture and purpose. Should not duplicate source code. Limited to generating README files.

↓ How To Install

  1. 1. Open your terminal

    Open the terminal or command line in your project directory.

  2. 2. Run the install command

    Run: npx killer-skills add skrischer/structcms/write-readme. The CLI will automatically detect your IDE or AI agent and configure the skill.

  3. 3. Start using the skill

    The skill is now active. Your AI agent can use write-readme immediately in the current project.

Related Skills

Looking for an alternative to write-readme or another community skill for your workflow? Explore these related open-source skills.

View All

widget-generator

Logo of f
f

f.k.a. Awesome ChatGPT Prompts. Share, discover, and collect prompts from the community. Free and open source — self-host for your organization with complete privacy.

★ 149.6k
⑂ 0
AI

flags

Logo of vercel
vercel

flags is a Next.js feature management skill that enables developers to efficiently add or modify framework feature flags, streamlining React application development.

★ 138.4k
⑂ 0
Browser

zustand

Logo of lobehub
lobehub

The ultimate space for work and life — to find, build, and collaborate with agent teammates that grow with you. We are taking agent harness to the next level — enabling multi-agent collaboration, effortless agent team design, and introducing agents as the unit of work interaction.

★ 72.8k
⑂ 0
AI

data-fetching

Logo of lobehub
lobehub

The ultimate space for work and life — to find, build, and collaborate with agent teammates that grow with you. We are taking agent harness to the next level — enabling multi-agent collaboration, effortless agent team design, and introducing agents as the unit of work interaction.

★ 72.8k
⑂ 0
AI