Skills
.Work. You
Rest

write-skill-readme

Community

Auto-generate polished skill READMEs.

Content & Communication#automation#documentation#markdown#skills#readme#generate
Authorhuangwb8
Version1.0.0
Installs0

System Documentation

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，使用默认模板。

Dependency Matrix

Required Modules

None required

Components

references

💻 Claude Code Installation

Recommended: Let Claude install automatically. Simply copy and paste the text below to Claude Code.

Please help me install this Skill:
Name: write-skill-readme
Download link: https://github.com/huangwb8/skills/archive/main.zip#write-skill-readme

Please download this .zip file, extract it, and install it in the .claude/skills/ directory.
View Source Repository

Agent Skills Search Helper

Install a tiny helper to your Agent, search and equip skill from 471,000+ vetted skills library on demand.