skills.rest
ttphats
ttphatsCOMMUNITY
Explore all skills by this author →
WebsiteGitHub

create-readme

Generate structured README.md documentation from project analysis and templates.

Updated Jan 28, 2026
Search Tags:#template#documentation#markdown#github#readme#project documentation#generate
One-click install
npx skills add https://github.com/ttphats/project-detedxs26 --skill create-readme-ttphats
Or copy as Structured Prompt for Agent▼
Please help me install this Agent Skill.
Skill: create-readme
Source: https://github.com/ttphats/project-detedxs26/tree/main/.augment/skills/custom/create-readme
Command: npx skills add https://github.com/ttphats/project-detedxs26 --skill create-readme-ttphats

SYSTEM DOCUMENTATION & REQUIREMENTS

What problem does it solve? Writing a complete, well-structured README.md from scratch is time-consuming, and most projects end up with inconsistent or incomplete documentation that confuses new contributors and users. ## Core Features & Use Cases - Project Analysis: Scans dependencies, config files, directory structure, and existing docs to ground the README in the actual codebase. - Standardized Template: Generates sections based on Standard Readme, Google, and CNCF conventions, including features, tech stack table, quick start, architecture diagram, and troubleshooting. - Quality Validation: Runs a completeness checklist covering links, code block language tags, section presence, and anti-pattern detection. - Use Case: After scaffolding a new service, ask for a README and receive a production-grade document with badges, a directory tree, an ASCII architecture diagram, and a documentation index. ## Quick Start Ask the assistant to create a README for this project and answer its questions about the title, description, features, and tech stack.

Frequently Asked Questions about create-readme

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

FAQPage Schema
How do I generate a README.md for my project automatically?▼

Trigger the skill with phrases like "create readme" or "document this project". It scans your dependencies, config files, and directory structure, asks for key details like title and features, then generates a complete README.md following standard templates.

What sections should a good README include?▼

A complete README includes a one-sentence description, badges, 4-6 features, a tech stack table, a quick start of four steps or fewer, directory structure, architecture diagram, configuration, development, deployment, troubleshooting, contributing, license, and a documentation index.

What README template standards does this follow?▼

The generated README is based on the Standard Readme specification, the Google README style guide, and the CNCF project template. A full reusable template is stored in the skill's templates directory for reference.

Can it create an architecture diagram in the README?▼

Yes, for multi-component projects it generates an ASCII art architecture diagram showing components and their relationships. Single-component projects can omit this section without failing the quality checklist.

What are common README mistakes to avoid?▼

Common anti-patterns include descriptions longer than two sentences, missing quick start sections, no tech stack table, broken documentation links, and absent troubleshooting sections. The skill's quality checklist validates against all of these.

Related Skills

Explore More Software Engineering Skills→
stribusstribus
1

reversa-scout

Identify folders, languages, frameworks, dependencies, and entry points in legacy codebases.

Community
Advanced
mkalkeremkalkere
4

documentation

Generate and update READMEs, API docs, and guides from code.

Community
Advanced
Harvest-Forged-CodeHarvest-Forged-Code
10

documentation-generator

Generate and update project documentation from codebase exploration.

Official
Advanced
SayBGMSayBGM

moai-docs-generation

Generate technical documentation from source code and API definitions.

Community
Advanced