readme-generator

Readme Generator - Auto-activating skill for Technical Documentation. Triggers on: readme generator, readme generator Part of the Technical Documentation skill category.

1.02x

Quality

Does it follow best practices?

Impact

98%

1.02x

Average score across 3 eval scenarios

Securityby

Passed

No known issues

Optimize this skill with Tessl

npx tessl skill review --optimize ./planned-skills/generated/17-technical-docs/readme-generator/SKILL.md

Evaluation results

100%

README for Open-Source Node.js Utility Library

Industry-standard README structure

Criteria

Without context

With context

Markdown format

100%

Project description section

100%

Installation section

100%

Usage section

100%

API reference section

100%

Step-by-step code examples

100%

Contributing section

100%

License section

100%

No placeholder text

100%

Production-ready completeness

100%

Correct package name

100%

99%

API Reference Documentation for Inventory Service

API documentation generation

Criteria

Without context

With context

Markdown format

100%

Introduction section

100%

Authentication documented

100%

Base URL documented

100%

All endpoints present

100%

Request body documented

100%

Response documented

100%

Error codes documented

100%

Step-by-step examples

100%

No placeholder text

87%

Pagination documented

100%

95%

User Guide for DataPipe CLI Tool

User guide with step-by-step instructions

Criteria

Without context

With context

Markdown format

100%

Numbered installation steps

20%

50%

Installation commands in code blocks

100%

Configuration walkthrough

100%

First pipeline walkthrough

75%

100%

Validation step included

100%

Transform module explained

100%

No placeholder text

100%

Logical sequential flow

100%

Exit codes or troubleshooting

100%

Runnable commands shown

100%

Repository: jeremylongshore/claude-code-plugins-plus-skills
Commit: c8a915c

Evaluated: about 1 month ago
Agent: Claude Code
Model: Claude Sonnet 4.6

Table of Contents

README for Open-Source Node.js Utility Library API Reference Documentation for Inventory Service User Guide for DataPipe CLI Tool

Is this your skill?

If you maintain this skill, you can claim it as your own. Once claimed, you can manage eval scenarios, bundle related skills, attach documentation or rules, and ensure cross-agent compatibility.