Does README Author overwrite my existing manual content?

No, the skill is designed with a preservation-first approach. It respects custom prose and content within specific markers, using the AskUserQuestion function to confirm before making any major structural changes.

What is an 'Aha Moment' in a README?

The 'Aha Moment' is a 3-second visual demonstration, such as a terminal GIF or code snippet, that instantly communicates the core value and transformation your project provides to the user.

Can this skill generate logos for my documentation?

Yes, README Author automatically checks for existing logos and, if missing, invokes the project-logo-author skill to generate a high-quality visual for your project's hero section.

How does the validation scoring system work?

The validation operation scores your README against four distinct tiers: Essential (40%), Professional (25%), Elite (15%), and Virality (20%), ensuring your project meets elite standards for both utility and shareability.

README Author

Name: README Author
Author: tsilva

bytsilva

0•

学習とドキュメンテーション

Automates the creation and optimization of high-conversion GitHub README files using proven frameworks and virality hooks.

README Author is a specialized Claude Code skill designed to transform project documentation into powerful marketing and onboarding tools. By following a structured 'Hook-Prove-Enable-Extend' framework, it helps developers craft READMEs that capture attention in seconds and reduce time-to-first-success to under 10 minutes. The skill handles everything from automatic logo generation and badge placement to validating content against industry best practices and identifying the project's unique 'Aha moment' for maximum user engagement.

主な機能

01Automated README creation, modification, validation, and optimization.

02Intelligent preservation of manual notes and custom content blocks using markers.

03Integrated logo generation and retina-ready image metadata handling.

04Virality scoring and automated application of social proof and curiosity hooks.

05Aha Moment visualization to demonstrate project value in under 3 seconds.

060 GitHub stars

ユースケース

01Generating professional, standardized documentation for a new open-source repository.

02Synchronizing archive notices and project metadata across documentation automatically.

03Auditing and upgrading existing project READMEs to improve user retention and conversion.

What are Skills?·How to Install

Install with 🐟 Skill.Fish

npx skillfish add tsilva/claudeskillz project-readme-author

For use in Claude.ai and ChatGPT

Download Skill