Does this skill create files like LICENSE or CONTRIBUTING?

No, this skill is specifically focused on the README.md file. It intentionally avoids duplicating content found in dedicated files like LICENSE, CONTRIBUTING, or CHANGELOG.

What project data does the README Generator analyze?

The skill performs a deep review of the entire workspace, including file structure and code content, to ensure the generated README accurately reflects the project's purpose and functionality.

What formatting standards does the skill follow?

It uses GitHub Flavored Markdown (GFM) and includes modern GitHub admonition syntax (like note and warning blocks) to ensure maximum readability on GitHub.

Is the tone of the generated documentation customizable?

The skill is programmed to act as a senior software engineer, maintaining a professional, concise, and informative tone while avoiding the overuse of emojis.

Professional README Generator

Name: Professional README Generator
Author: baotoq

bybaotoq

•

学习与文档

Generates comprehensive, high-quality GitHub-flavored README files by analyzing the entire project workspace.

The Professional README Generator skill transforms Claude into a senior open-source engineer capable of auditing your entire codebase to produce elite-level project documentation. It moves beyond simple summaries, utilizing GitHub Flavored Markdown (GFM) and modern admonition syntax to create structured, readable, and visually appealing README.md files. By analyzing your project's architecture and purpose, it ensures that your repository makes a strong first impression with clear instructions and concise explanations, following the best practices of industry-leading repositories.

主要功能

01GitHub Flavored Markdown (GFM) formatting for modern repository standards

02Comprehensive project workspace analysis for accurate content generation

03Automatic discovery and integration of project logos and icons

041 GitHub stars

05Adherence to senior-level engineering documentation standards

06Integration of GitHub admonitions for better information hierarchy

使用场景

01Modernizing outdated project READMEs with professional formatting

02Initializing documentation for a new open-source repository

03Creating standardized documentation for internal team projects

What are Skills?·How to Install

Install with 🐟 Skill.Fish

npx skillfish add baotoq/agent-skills create-readme

For use in Claude.ai and ChatGPT