菜单
Generates a clear, well-structured project README from the codebase — title, badges, description, features, install, usage, configuration, contributing, and license. Use when the user asks to write, create, generate, or improve a README, project documentation, or docs for a repository.
用 Codex 或 Claude 帮你安装 复制这段 Prompt，粘贴到 Codex、Claude 或其他助手里，让它检查 Skill 页面并帮你完成安装。
基于 SOC 职业分类
Generates and maintains a CHANGELOG following the Keep a Changelog format, grouping changes into Added/Changed/Fixed/etc. and writing human-focused release notes from commits or a list of changes. Use when the user asks for a changelog, release notes, what's new, or wants to cut a release or prepare an Unreleased section.
Writes Conventional Commits messages from a diff or change description, choosing the correct type and scope, writing an imperative subject, and flagging breaking changes. Use when the user asks for a commit message, wants to commit staged changes, or mentions conventional commits, semantic commits, or commit conventions.
Writes clear, reviewer-friendly pull request titles and descriptions from a diff or branch — summary of what and why, key changes, testing notes, and a review checklist. Use when the user asks to write a PR description, open a pull request, summarize a branch for review, or fill in a PR template.
Audits HTML, JSX, and UI components for accessibility (a11y) problems against WCAG 2.2 AA, reporting each issue with severity, the success criterion, and a concrete code fix. Use when the user asks to check accessibility, mentions a11y, WCAG, screen readers, keyboard navigation, color contrast, ARIA, or alt text, or shares markup to review.
Reviews REST/HTTP and JSON API designs for consistency, correctness, and evolvability — resource naming, HTTP methods and status codes, pagination, filtering, errors, versioning, idempotency, and auth. Use when the user shares an API spec, OpenAPI/Swagger doc, endpoint list, or route handlers, or asks to review, critique, or design an API.
Hardens and optimizes Dockerfiles for security and size — non-root user, pinned base images, multi-stage builds, minimal layers, no leaked secrets, and a proper healthcheck. Use when the user shares a Dockerfile, asks to harden, secure, or shrink a container image, reduce attack surface, or follow Docker best practices.
| name | readme-generator |
| description | Generates a clear, well-structured project README from the codebase — title, badges, description, features, install, usage, configuration, contributing, and license. Use when the user asks to write, create, generate, or improve a README, project documentation, or docs for a repository. |
| license | MIT |
| metadata | {"author":"ATOM00blue","version":"1.0.0","category":"documentation"} |
Write a README that lets a newcomer understand the project and get it running in minutes. Base it on the actual repository, not assumptions.
- [ ] 1. Learn the project (manifest, entry point, scripts, existing docs)
- [ ] 2. Draft sections in priority order
- [ ] 3. Make every command copy-pasteable and accurate
- [ ] 4. Trim filler; keep it scannable
Ground the README in evidence. Inspect:
package.json, pyproject.toml, go.mod, Cargo.toml) for name,
description, scripts, dependencies, and entry point..env.example, and any docs to reuse.Never invent install commands, options, or badges that aren't true.
# Project Name
> One-sentence description of what it does and who it's for.
[badges: build, version, license, etc.]
Short paragraph: the problem it solves and why someone would use it.
## Features
- Key capability 1
- Key capability 2
## Quick start / Installation
\`\`\`bash
<exact install command>
\`\`\`
## Usage
\`\`\`bash
<minimal working example with expected output>
\`\`\`
## Configuration
| Option | Default | Description |
| ------ | ------- | ----------- |
## API / Commands (if applicable)
## Contributing (link to CONTRIBUTING.md if it exists)
## License
Add a Table of Contents only for long READMEs. Add Screenshots/Demo near the top for anything with a UI. Omit sections that don't apply rather than padding them.
Use shields.io. Common, accurate badges:
Don't add badges for services the project doesn't use.
# wc-rs
> A fast, drop-in `wc` replacement written in Rust.
`wc-rs` counts lines, words, and bytes 4–6x faster than GNU `wc` on large files,
with the same flags you already know.
## Features
- Drop-in compatible flags (`-l`, `-w`, `-c`, `-m`)
- Parallel processing for multiple files
- Zero dependencies, single static binary
## Installation
\`\`\`bash
cargo install wc-rs
\`\`\`
## Usage
\`\`\`bash
wc-rs -l README.md
# 42 README.md
\`\`\`
## License
MIT — see [LICENSE](LICENSE).