github/create-readme

Role

You're a senior expert software engineer with extensive experience in open source projects. You always make sure the README files you write are appealing, informative, and easy to read.

Task

Take a deep breath, and review the entire project and workspace, then create a comprehensive and well-structured README.md file for the project.
Take inspiration from these readme files for the structure, tone and content:
Do not overuse emojis, and keep the readme concise and to the point.
Do not include sections like "LICENSE", "CONTRIBUTING", "CHANGELOG", etc. There are dedicated files for those sections.
Use GFM (GitHub Flavored Markdown) for formatting, and GitHub admonition syntax (https://github.com/orgs/community/discussions/16925) where appropriate.
If you find a logo or icon for the project, use it in the readme's header.

Files1

1 files · 1.0 KB

Select a file to preview

Overall Score

82/100

Grade

B

Good

Safety

85

Quality

82

Clarity

85

Completeness

75

Summary

This skill guides an AI agent to create a comprehensive README.md file for a project by first reviewing the entire codebase, then generating well-structured documentation inspired by reference examples. The skill emphasizes clarity, conciseness, and GitHub Flavored Markdown formatting, with explicit guidance on what sections to exclude and how to handle media assets.

Detected Capabilities

file read (project/codebase analysis)file write (README.md creation)http request (fetch reference README examples from GitHub)markdown generationproject-scoped content creation

Trigger Keywords

Phrases that MCP clients use to match this skill to user intent.

create readmegenerate documentationwrite project readmereadme from scratchdocument new projectreadme best practices

Risk Signals

INFO

External URL references to github.com and raw.githubusercontent.com for README inspiration

Task section, items 2

INFO

Instructs agent to review entire project and workspace

Task section, item 1

Referenced Domains

External domains referenced in skill content, detected by static analysis.

github.comraw.githubusercontent.com

Use Cases

Generate a project README from scratch during initial setup
Update README documentation for an existing project
Ensure README follows best practices and GitHub standards
Create documentation inspired by well-regarded open-source examples
Standardize README structure across multiple projects in an organization

Quality Notes

Clear, well-structured instructions organized by numbered task steps
Explicit constraints provided (no overuse of emojis, exclude LICENSE/CONTRIBUTING/CHANGELOG sections)
Concrete reference examples from GitHub make the expected output style clear
Good guidance on formatting (GFM, admonitions, logo inclusion)
Scope is narrowly focused: only README.md file generation, with clear boundaries on what NOT to include
Instructions reference authoritative GitHub documentation (admonition syntax link)
Helpful persona context (senior engineer perspective) sets appropriate tone
No error handling documented for cases like missing project description or inability to identify a logo

Model: claude-haiku-4-5-20251001Analyzed: Jun 26, 2026

Reviews

Add this skill to your library to leave a review.

No reviews yet

Be the first to share your experience.

create-readme