skills.rest
Alejfanjul
AlejfanjulCOMMUNITY
Explore all skills by this author →
GitHub

skill-doc-generator

Parses SKILL.md files to extract metadata, sections, and resources, then generates READMEs with validation results.

Updated Aug 27, 2026
Search Tags:#automation#documentation#markdown#validation#readme#analyze
One-click install
npx skills add https://github.com/Alejfanjul/ai-brain --skill skill-doc-generator-alejfanjul
Or copy as Structured Prompt for Agent▼
Please help me install this Agent Skill.
Skill: skill-doc-generator
Source: https://github.com/Alejfanjul/ai-brain/tree/main/sources/claude-meta-skills/skill-doc-generator
Command: npx skills add https://github.com/Alejfanjul/ai-brain --skill skill-doc-generator-alejfanjul

SYSTEM DOCUMENTATION & REQUIREMENTS

💡 This Skill requires pyyaml, and includes scripts (resource) and references (resource) components.

What problem does it solve?

Automates the creation of standardized, high-quality README documentation for skills by analyzing SKILL.md, extracting structure and examples, and generating consistent outputs with embedded validation results.

Core Features & Use Cases

  • Analyze: Parses SKILL.md to extract metadata (name, description), sections, code blocks, and bundled resources.
  • Validate: Checks frontmatter, terminology, structure, and resource references against defined standards, returning actionable feedback.
  • Generate: Produces a ready-to-use README.md that summarizes the skill analysis, usage instructions, resource lists, and validation results.

Quick Start

Run the tool on a directory containing SKILL.md to generate a complete README with validation details.

Frequently Asked Questions about skill-doc-generator

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

FAQPage Schema
How do I auto-generate a README from a SKILL.md file?▼

To auto-generate a README from SKILL.md, you need a tool that parses structured metadata, sections, and code blocks to produce standardized documentation with validation results. This skill analyzes SKILL.md and outputs a ready-to-use README.md automatically.

What is SKILL.md documentation validation and how does it work?▼

SKILL.md documentation validation checks frontmatter, terminology, structure, and resource references against defined standards. It parses the file to extract metadata and code blocks, returning actionable feedback embedded within the generated README output.

Can I batch process multiple skill directories to generate markdown documentation?▼

Yes, you can batch process multiple skill directories to generate markdown documentation. The tool applies automated documentation pipelines to single-skill directories or batch processing, extracting structure and examples to produce consistent READMEs.

Do I need pyyaml installed to extract frontmatter and parse markdown sections?▼

Yes, you need pyyaml installed to extract frontmatter and parse markdown sections effectively. This dependency supports the automated analysis of SKILL.md files, enabling the extraction of structured metadata and resource references for README generation.

What is the best way to automate README creation for skills with bundled resources?▼

The best way to automate README creation for skills with bundled resources is using a tool that extracts and references those resources during parsing. This skill analyzes SKILL.md, captures bundled resources, and generates a README with a complete resource list and validation results.

Related Skills

Explore More Content & Communication Skills→
andreaswasitaandreaswasita
33

<skill-name-in-kebab-case>

Parse SKILL.md frontmatter to extract and validate Skill Unit metadata.

Community
Basic
bresillabresilla
1

readme

Generate standardized README.md scaffolds for ROBOLIBS libraries with required sections and 350-400 lines.

Community
Basic
kcenonkcenon
2

documentation

Enforce documentation standards for READMEs, API docs, and code comments.

Community
Basic
DidierRLopesDidierRLopes
8

convert-beehiiv-newsletter

Convert Beehiiv newsletter posts into blog markdown files with front matter and images.

Community
Advanced