Skip to content
cccskills
FreePublished on GitHub

readme-doctor

Reviews a README for the things that make people try a project, covering the opening line, install steps, a runnable example, proof that it works and contribution info, then proposes concrete edits. Use when the user asks to improve a README, wants more stars or users for an open source project, or is preparing a launch.

The English summary is being prepared. Showing the original description.

Lethe044/agentskill-kit48 stars(GitHub 48 + cccskills 0)

Run score Not tested

See how to install

Files included (1)

  • SKILL.md2.2 KB

SKILL.md (original)

Review the instructions the agent will receive before you install.

README doctor

Most visitors decide in under a minute. The README has to answer three questions fast: what is this, does it solve my problem, and how do I try it.

When to use

  • The user shares a README and asks for feedback.
  • A project is about to be announced on a forum or social media.
  • The repository has traffic but few stars or issues.

Review order

  1. Opening line. One sentence naming the problem and the audience. Reject slogans and buzzwords.
  2. Proof above the fold. A terminal recording, screenshot or short output sample within the first screen.
  3. Install. One command that works on a clean machine. State supported platforms and versions.
  4. First success. A minimal example whose output is shown, so the reader sees the result without running it.
  5. Why this exists. Two or three sentences on how it differs from the alternatives, with honest limits.
  6. Features. A short list of things the tool does, written as capabilities, not adjectives.
  7. Reference. Commands, options and configuration in tables or short sections.
  8. Project health. Badges for CI and version, license, contributing guide, roadmap, how to report bugs.

Rules

  • Check every command and link before recommending them. Do not suggest claims that cannot be shown.
  • Cut anything that sounds like marketing and does not carry information.
  • Prefer showing a real output to describing it.
  • Suggest a repository description and topics that match what people search for.

Output

Return a prioritized list: the three changes with the most impact first, each with a before and after snippet. End with a short checklist of what is still missing.

Errors

If the README is empty, ask what the project does and who it is for, then draft only the opening line and the install section.

Reviews

No reviews yet. Tell others what you thought.

Comments

No login needed. Share how it worked for you, ask a question, or note where it did not run.

No comments yet. Be the first to write one.

Comments are published right away. Do not include personal information such as email addresses or phone numbers. Up to 2 URLs.

0 / 1,000 characters

This form is protected by reCAPTCHA, and the Google Privacy Policy and Terms of Service apply.

More skills from this repository

Runs a list of HTTP checks against a base URL from a JSON file and reports status codes, response time and body assertions. Use when the user asks whether an API is up, wants a smoke test after a deploy, or needs to verify that endpoints return what the docs promise.

The English summary is being prepared. Showing the original description.

Lethe044/agentskill-kit48Updated Oct 26, 2026

Turns git log output into a grouped markdown changelog using conventional commit prefixes such as feat, fix and docs. Use when the user prepares a release, asks for release notes, or wants a summary of what changed between two tags.

The English summary is being prepared. Showing the original description.

Lethe044/agentskill-kit48Updated Oct 26, 2026

Writes clear git commit messages in the conventional commits style from a diff or a description of the change. Use when the user asks for a commit message, wants to tidy up a message before pushing, or has staged changes and no wording yet.

The English summary is being prepared. Showing the original description.

Lethe044/agentskill-kit48Updated Oct 26, 2026

Profiles a CSV file column by column, reporting inferred type, missing values, unique counts and min, max and mean for numeric columns. Use when the user hands over a CSV and asks what is in it, whether the data is clean, or what to check before analysis.

The English summary is being prepared. Showing the original description.

Lethe044/agentskill-kit48Updated Oct 26, 2026

Checks a Dockerfile for common problems such as unpinned base images, running as root, ADD instead of COPY, secrets in ENV or ARG and apt-get without cleanup. Use when the user asks to review, harden or slim down a Dockerfile.

The English summary is being prepared. Showing the original description.

Lethe044/agentskill-kit48Updated Oct 26, 2026

Compares a .env file with its .env.example template and reports missing keys, undocumented extra keys, empty values and example files that contain real looking secrets. Use when the user asks why an app fails on startup with missing configuration, or wants to check environment files before committing.

The English summary is being prepared. Showing the original description.

Lethe044/agentskill-kit48Updated Oct 26, 2026

See all skills by Lethe044

Report a problem with this skill