readme-generator
Readme Generator - Auto-activating skill for Technical Documentation. Triggers on: readme generator, readme generator Part of the Technical Documentation skill category.
36
Quality
3%
Does it follow best practices?
Impact
98%
1.02xAverage score across 3 eval scenarios
Passed
No known issues
Optimize this skill with Tessl
npx tessl skill review --optimize ./planned-skills/generated/17-technical-docs/readme-generator/SKILL.mdEvaluation results
100%
README for Open-Source Node.js Utility Library
Industry-standard README structure
Markdown format
100%
100%
Project description section
100%
100%
Installation section
100%
100%
Usage section
100%
100%
API reference section
100%
100%
Step-by-step code examples
100%
100%
Contributing section
100%
100%
License section
100%
100%
No placeholder text
100%
100%
Production-ready completeness
100%
100%
Correct package name
100%
100%
Without context: $0.1752 · 46s · 8 turns · 9 in / 2,783 out tokens
With context: $0.3683 · 1m 21s · 20 turns · 177 in / 4,312 out tokens
99%
API Reference Documentation for Inventory Service
API documentation generation
Markdown format
100%
100%
Introduction section
100%
100%
Authentication documented
100%
100%
Base URL documented
100%
100%
All endpoints present
100%
100%
Request body documented
100%
100%
Response documented
100%
100%
Error codes documented
100%
100%
Step-by-step examples
100%
100%
No placeholder text
87%
87%
Pagination documented
100%
100%
Without context: $0.1868 · 53s · 9 turns · 10 in / 3,469 out tokens
With context: $0.3559 · 1m 25s · 18 turns · 272 in / 4,708 out tokens
95%
6%User Guide for DataPipe CLI Tool
User guide with step-by-step instructions
Markdown format
100%
100%
Numbered installation steps
20%
50%
Installation commands in code blocks
100%
100%
Configuration walkthrough
100%
100%
First pipeline walkthrough
75%
100%
Validation step included
100%
100%
Transform module explained
100%
100%
No placeholder text
100%
100%
Logical sequential flow
100%
100%
Exit codes or troubleshooting
100%
100%
Runnable commands shown
100%
100%
Without context: $0.2394 · 1m 18s · 12 turns · 15 in / 4,608 out tokens
With context: $0.4440 · 1m 50s · 22 turns · 275 in / 6,226 out tokens
- Commit
0c08951
- Evaluated
- Agent
- Claude Code
- Model
- Claude Sonnet 4.6
Table of Contents
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.