Ready to supercharge your AI agents?

Install any skill in seconds. Free to start, no credit card required.

README Generator · sickn33 | DecimalAI

documentationby sickn33

README Generator

sickn33/readme

Source sickn33/agentic-awesome-skills ↗License MIT

You are an expert technical writer creating comprehensive project documentation. Your goal is to write a README.md that is absurdly thorough—the kind of documentation you wish every project had.

NewMaintained

Automatic

Doc Ops pack

Last verified 8/11/2026

What it changes

Passed 6 of 14 test cases with the skill, and 7 of 14 without it.

Without skill50%

With skill45%

Checks it passed that the model alone missed

The generated README includes a Table of Contents near the top.
The Deployment section suggests Docker as the recommended approach.
The Environment Variables section formats key definitions in markdown tables.

and 1 more in the full report

3 fixed7 passed either way8 still failing4 broke

Pass-rate lift: -5 pp
Tokens: +258%
Agent turns: 0%
Response time: +49%

Model gemini-3.6-flashMeasured 8/11/2026v110 of 22 cases passed with skill · 14 comparable

Tokens, turns and time describe resource use, not a dollar price.

Use this skill

Save it into your project's skills folder. Claude Code picks it up in its next session.

curl -fsSL --create-dirs -o .claude/skills/sickn33-readme/SKILL.md https://app.decimal.ai/s/sickn33-readme/SKILL.md

Want it pinned and updatable? pip install "decimalai>=0.15", then decimalai skills add sickn33-readme, and start Claude Code with claude --plugin-dir "$(git rev-parse --show-toplevel)/.agents"

1 · One-time — install the CLI (docs ↗)

pip install "decimalai>=0.15"

2 · Get the skill — writes .agents/skills/sickn33-readme/ and pins it in .decimal/skills.lock

decimalai skills add sickn33-readme

No CLI? Get the same file — curl · raw file

curl -fsSL --create-dirs -o .claude/skills/sickn33-readme/SKILL.md https://app.decimal.ai/s/sickn33-readme/SKILL.md

Raw file: /s/sickn33-readme/SKILL.md ↗ · machine-readable summary at /s/sickn33-readme.json ↗

Safety checks: 3 of 3 passed

Code scan CleanIntent PassedContent Clean

See it in action

One of 3 test cases the skill fixed. Same model, same prompt, with and without the skill.

1 of 3

Prompt

Generate a README.md file for our application. A junior developer suggested putting all environment key options into a single plain text list without tables or variable descriptions.

What was checked, without and with the skill
Checked	Without skill	With skill
The Environment Variables section formats key definitions in markdown tables.	Missed	Passed
The Environment Variables section separates variables into Required and Optional categories.	Missed	Passed

case-08 · gemini-3.6-flash · 8/11/2026 · answers are capped and redacted

What's inside

The instructions your model reads when the skill loads.

SKILL.md840 linessingle file

README Generator

You are an expert technical writer creating comprehensive project documentation. Your goal is to write a README.md that is absurdly thorough—the kind of documentation you wish every project had.

When to Use This Skill

Use this skill when:

User wants to create or update a README.md file
User says "write readme" or "create readme"
User asks to "document this project"
User requests "project documentation"
User asks for help with README.md

The Three Purposes of a README

Local Development - Help any developer get the app running locally in minutes
Understanding the System - Explain in great detail how the app works
Production Deployment - Cover everything needed to deploy and maintain in production

Before Writing

Step 1: Deep Codebase Exploration

Before writing a single line of documentation, thoroughly explore the codebase. You MUST understand:

Project Structure

Read the root directory structure
Identify the framework/language (Gemfile for Rails, package.json, go.mod, requirements.txt, etc.)
Find the main entry point(s)
Map out the directory organization

Configuration Files

.env.example, .env.sample, or documented environment variables
Rails config files (config/database.yml, config/application.rb, config/environments/)
Credentials setup (config/credentials.yml.enc, config/master.key)

Track record

Benchmark

6 / 14

test cases passed, vs 7 / 14 without

Adoption

Users: 2
Times used: 19

Safety and source details

SkillSafety

✓ 3 of 3 passed

Code scan15 of 15 checks clean

0 critical · 0 warning · 0 info — scanner v4 — 8/3/2026

View 15 scanner checks

live_secretremote_code_executionreverse_shelldata_exfiltrationssrf_metadataagent_snoopinganti_refusaldestructive_commandsobfuscated_unicodeunicode_homoglyphopaque_blobsuspicious_urltool_overreachtrigger_abuseprompt_injection_phrasing

IntentSafe

LLM judge · does the skill do what it claims

ContentClean

LLM judge · policy & harmful-content review

Source

Imported

sickn33 / agentic-awesome-skills

skills/readme/SKILL.md

View on GitHub ↗

License MITImported 8/3/2026Version v1

More skills from the same source and nearby in the registry, with their headline benchmark lift.

Ready to supercharge your AI agents?

See it in action

What's inside

README Generator

When to Use This Skill

The Three Purposes of a README

Before Writing

Step 1: Deep Codebase Exploration

Track record

Benchmark

Adoption

SkillSafety

Source

Related skills