skills.rest
rfxlamia
rfxlamiaCOMMUNITY
Explore all skills by this author →
WebsiteGitHub

readme-expert

Generate README.md documents by extracting repository facts and validating them against source files.

100|15|Updated Nov 13, 2025
Search Tags:#testing#documentation#codebase#validation#readme#citations#anti-hallucination
One-click install
npx skills add https://github.com/rfxlamia/claude-skillkit --skill readme-expert
Or copy as Structured Prompt for Agent▼
Please help me install this Agent Skill.
Skill: readme-expert
Source: https://github.com/rfxlamia/claude-skillkit/tree/main/skills/readme-expert
Command: npx skills add https://github.com/rfxlamia/claude-skillkit --skill readme-expert

SYSTEM DOCUMENTATION & REQUIREMENTS

What problem does it solve?

Create comprehensive, accurate README.md files with anti-hallucination validation.

Core Features & Use Cases

  • Codebase scanning for accurate facts
  • 5-layer anti-hallucination validation
  • Script execution testing
  • Citation tracking for all claims
  • Template-based structure selection

Quick Start

Generate a validated README for a project by scanning the codebase, extracting facts, and testing examples.

Frequently Asked Questions about readme-expert

High-intent search queries and answers about installing and using this skill.

FAQPage Schema
How do I generate a README from my codebase without hallucinating API references?▼

Generate a code-grounded README by scanning the repository to extract facts and validating them against source files. It enforces anti-hallucination through 5-layer validation, citation tracing, and script-execution testing.

What is anti-hallucination validation for project documentation?▼

Anti-hallucination validation ensures README claims match the actual codebase using 5-layer validation, citation tracing for all facts, and script-execution testing to verify usage examples.

Can I use template-based structure selection for updating an existing README?▼

Yes, template-based structure selection applies to new projects, updates, and validations. It extracts codebase facts to populate installation, usage, API references, and license sections where relevant.

What is the best way to validate README usage examples against source files?▼

Validate README usage examples through script-execution testing and citation tracking. The 5-layer validation cross-references extracted documentation facts directly against the codebase source files.

Does the documentation generator work without external dependencies?▼

Yes, the documentation generator operates with no external dependencies. It scans the codebase internally to extract facts and applies 5-layer anti-hallucination validation.

Related Skills

Explore More Software Engineering Skills→
darelabs-techdarelabs-tech

dare-patterns

Mine brownfield software patterns via AST analysis to generate architectural documentation and JSON facts.

Official
Intermediate
bvshibvshi

10x-init

Create /context directories for changes, archive, and foundation with README files.

Community
Intermediate
mattbobambrosemattbobambrose
1

update-readme

Analyze build files and source directories to update README.md in GitHub-flavored Markdown.

Community
Intermediate
AcidicSoilAcidicSoil
1

validate-story

Validates story drafts against a 10-step blueprint and reports a GO/NO-GO decision.

Community
Advanced