write-readme — community write-readme, structcms, community, ide skills, Claude Code, Cursor, Windsurf

v1.0.0
GitHub

About this Skill

Perfect for Developer Agents needing high-quality README file generation for package and app documentation. Write or update a README.md file following project conventions. Use when creating, updating, or reviewing any README in the StructCMS monorepo.

skrischer skrischer
[0]
[0]
Updated: 3/12/2026

Killer-Skills Review

Decision support comes first. Repository text comes second.

Reference-Only Page Review Score: 7/11

This page remains useful for operators, but Killer-Skills treats it as reference material instead of a primary organic landing page.

Original recommendation layer Concrete use-case guidance Explicit limitations and caution Locale and body language aligned
Review Score
7/11
Quality Score
36
Canonical Locale
en
Detected Body Locale
en

Perfect for Developer Agents needing high-quality README file generation for package and app documentation. Write or update a README.md file following project conventions. Use when creating, updating, or reviewing any README in the StructCMS monorepo.

Core Value

Empowers agents to create informative README files describing architecture, purpose, and usage of packages or apps, utilizing Markdown formatting and referencing source files like `lib/adapters.ts` for adapter configuration, while avoiding code duplication and including short setup snippets like `.env` examples or CLI commands.

Ideal Agent Persona

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

↓ Capabilities Granted for write-readme

Generating README files for new package releases
Automating documentation updates for app architecture changes
Creating informative README files for open-source projects

! Prerequisites & Limits

  • Requires knowledge of Markdown formatting
  • Should not duplicate source code
  • Limited to generating README files, not other documentation types

Why this page is reference-only

  • - The underlying skill quality score is below the review floor.

Source Boundary

The section below is supporting source material from the upstream repository. Use the Killer-Skills review above as the primary decision layer.

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

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 and app documentation. Write or update a README.md file following project conventions. Use when creating, updating, or reviewing any README in the StructCMS monorepo.

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 informative README files for open-source projects.

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 Markdown formatting. Should not duplicate source code. Limited to generating README files, not other documentation types.

↓ 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.

! Reference-Only Mode

This page remains useful for installation and reference, but Killer-Skills no longer treats it as a primary indexable landing page. Read the review above before relying on the upstream repository instructions.

Imported Repository Instructions

The section below is supporting source material from the upstream repository. Use the Killer-Skills review above as the primary decision layer.

Supporting Evidence

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
Imported Repository Instructions
The section below is supporting source material from the upstream repository. Use the Killer-Skills review above as the primary decision layer.
Supporting Evidence

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

Related Skills

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

View All

openclaw-release-maintainer

Logo of openclaw
openclaw

Your own personal AI assistant. Any OS. Any Platform. The lobster way. 🦞

★ 333.8k
⑂ 0
AI

widget-generator

Logo of f
f

Generate customizable widget plugins for the prompts.chat feed system

★ 149.6k
⑂ 0
AI

flags

Logo of vercel
vercel

The React Framework

★ 138.4k
⑂ 0
Browser

pr-review

Logo of pytorch
pytorch

Tensors and Dynamic neural networks in Python with strong GPU acceleration

★ 98.6k
⑂ 0
Developer