readme-generator
Readme Generator - Auto-activating skill for Technical Documentation. Triggers on: readme generator, readme generator Part of the Technical Documentation skill category.
Overall
score
19%
Does it follow best practices?
Validation for skill structure
Install with Tessl CLI
npx tessl i github:jeremylongshore/claude-code-plugins-plus-skills --skill readme-generatorActivation
7%This description is essentially a placeholder that provides almost no useful information for skill selection. It lacks concrete actions, meaningful trigger terms, and explicit usage guidance. The redundant trigger term and generic category label suggest this was auto-generated without human refinement.
Suggestions
Add specific actions the skill performs, e.g., 'Generates README.md files with project overview, installation instructions, usage examples, and API documentation sections.'
Include a 'Use when...' clause with natural trigger terms: 'Use when the user asks to create a README, needs project documentation, mentions README.md, or wants to document a repository.'
Add variations of trigger terms users would naturally say: 'readme', 'README.md', 'project documentation', 'document this repo', 'create documentation'
| Dimension | Reasoning | Score |
|---|---|---|
Specificity | The description only states 'Readme Generator' and 'Technical Documentation' without describing any concrete actions. It doesn't explain what the skill actually does (e.g., creates README files, generates documentation sections, formats markdown). | 1 / 3 |
Completeness | The description fails to answer 'what does this do' beyond the name, and the 'when' guidance is essentially just repeating the skill name as a trigger. There's no explicit 'Use when...' clause with meaningful context. | 1 / 3 |
Trigger Term Quality | The trigger terms listed are just 'readme generator' repeated twice, which is redundant and misses natural variations users would say like 'create readme', 'README.md', 'project documentation', 'write a readme', etc. | 1 / 3 |
Distinctiveness Conflict Risk | While 'readme' is somewhat specific, the vague 'Technical Documentation' category could overlap with other documentation skills. The lack of specific actions makes it unclear how this differs from general documentation tools. | 2 / 3 |
Total | 5 / 12 Passed |
Implementation
0%This skill is entirely meta-content describing what a README generator skill would do, without providing any actual README generation guidance. It contains no templates, no examples of good READMEs, no structure recommendations, and no actionable instructions. The content is pure boilerplate that could apply to any skill with minimal word substitution.
Suggestions
Add a concrete README template with sections (Title, Description, Installation, Usage, Contributing, License) that Claude can adapt
Include 2-3 example README outputs for different project types (library, CLI tool, web app) showing expected format and content
Provide specific instructions for extracting project information (reading package.json, pyproject.toml, etc.) to auto-populate README sections
Add a checklist of README quality criteria (has badges, has examples, has clear installation steps) for validation
| Dimension | Reasoning | Score |
|---|---|---|
Conciseness | The content is padded with generic boilerplate that provides no actual value. Phrases like 'provides automated assistance' and 'follows industry best practices' are vague filler that Claude doesn't need. | 1 / 3 |
Actionability | There is zero concrete guidance - no code examples, no specific commands, no actual instructions on how to generate a README. The content only describes what the skill supposedly does without showing how. | 1 / 3 |
Workflow Clarity | No workflow is defined at all. There are no steps, no sequence, and no validation checkpoints. The skill claims to provide 'step-by-step guidance' but contains none. | 1 / 3 |
Progressive Disclosure | The content is a monolithic block of meta-description with no actual content to organize. There are no references to detailed materials, examples, or templates that would be essential for a README generator skill. | 1 / 3 |
Total | 4 / 12 Passed |
Validation
69%Validation — 11 / 16 Passed
Validation for skill structure
| Criteria | Description | Result |
|---|---|---|
description_trigger_hint | Description may be missing an explicit 'when to use' trigger hint (e.g., 'Use when...') | Warning |
allowed_tools_field | 'allowed-tools' contains unusual tool name(s) | Warning |
metadata_version | 'metadata' field is not a dictionary | Warning |
frontmatter_unknown_keys | Unknown frontmatter key(s) found; consider removing or moving to metadata | Warning |
body_steps | No step-by-step structure detected (no ordered list); consider adding a simple workflow | Warning |
Total | 11 / 16 Passed | |
Reviewed
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.