skills.rest
huangwb8
huangwb8COMMUNITY
Explore all skills by this author →
WebsiteGitHub

write-skill-readme

Generate a README.md from Skill definition files in read-only mode.

47|8|Updated Jan 3, 2026
Search Tags:#automation#documentation#markdown#skills#readme#generate
One-click install
npx skills add https://github.com/huangwb8/skills --skill write-skill-readme
Or copy as Structured Prompt for Agent▼
Please help me install this Agent Skill.
Skill: write-skill-readme
Source: https://github.com/huangwb8/skills/tree/main/write-skill-readme
Command: npx skills add https://github.com/huangwb8/skills --skill write-skill-readme

SYSTEM DOCUMENTATION & REQUIREMENTS

💡 This Skill includes references (resource) components.

What problem does it solve?

本技能帮助团队自动为 Agent Skills 生成可发布的 README.md 文档，通过分析技能定义文件（SKILL.yaml、SKILL.md、config.yaml、scripts/、references/）提取关键信息并输出结构化的使用指南。

Core Features & Use Cases

  • 自动分析并理解技能结构与工作流，输出一致的 README.md 框架
  • 根据技能特征自动选择模板（功能型/工具型/混合型），覆盖快速开始、设计理念、使用场景、配置选项与 FAQ
  • 只读分析输入，确保不修改原始技能文件，直接生成可发布的 README.md

Quick Start

生成 skills/your-skill 的 README.md，使用默认模板。

Frequently Asked Questions about write-skill-readme

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

FAQPage Schema
How do I auto-generate a README.md from skill definition files?▼

It selects a functional, tooling, or hybrid template based on the analyzed skill characteristics, then outputs a structured README covering Quick Start, design philosophy, usage examples, and FAQ sections. This ensures documentation remains consistent with the actual skill definition.

Can I generate markdown documentation without modifying my original skill scripts?▼

Yes, you can generate markdown documentation without modifying original skill scripts because this tool operates strictly in read-only mode. It analyzes your SKILL.yaml and scripts directories to extract metadata, outputting only the standalone README.md file.

What is the best way to create consistent usage examples for agent skills?▼

By selecting a functional, tooling, or hybrid template, it standardizes the documentation framework across multiple skills. This ensures every generated README includes consistent sections for configuration options, quick start guides, and frequently asked questions.

Does the generated README include a design philosophy section for skills?▼

The generated README covers design philosophy, quick start, usage scenarios, configuration options, and FAQ. It derives this content by evaluating the skill's components and workflow logic defined in SKILL.yaml and SKILL.md.

Are there limitations to automating skill documentation with markdown templates?▼

A limitation of automating skill documentation is that the output depends entirely on the completeness of your SKILL.yaml and config.yaml definitions. It cannot infer features not present in the source files, and it only outputs a README.md without modifying underlying scripts.

Related Skills

Explore More Content & Communication Skills→
apifyapify
239

Template for a customizable Skill Unit.

Official
Basic
goondocks-cogoondocks-co
12

myco:write-myco-user-documentation

Enforce the Myco doc-voice contract on user-facing documentation before commits.

Official
Intermediate
goranjovic55goranjovic55

documentation

Enforce Markdown documentation structure and formatting patterns via skill.yaml configuration.

Community
Advanced
jimuttjimutt
4

dld-snapshot

Generate SNAPSHOT.md and OVERVIEW.md documentation from a decision log.

Community
Intermediate