AgentSkillsCN

readme-generator

根据自然语言描述生成全新的 Agent 技能。创建完整的 SKILL.md 文件，包含 YAML 前言、详细说明，以及文件夹结构建议。

SKILL.md
--- frontmatter
name: readme-generator
description: >
  Generate professional README.md files for projects. Use when asked to create, update, or improve README documentation, extract project metadata, or suggest README structure and content.
version: 1

Purpose

Create high-quality, production-ready README.md files for any project, based on project files, metadata, and user input.

Process

  1. •Parse request: Extract project name, purpose, tech stack, and any user-supplied details
  2. •Generate YAML: name, description, version: 1
  3. •Write instructions: Purpose, rules, examples, resources
  4. •Suggest structure: Standard README sections (Description, Installation, Usage, License, etc.)
  5. •Validate: Ensure clarity, completeness, and best practices

Output Format

name: readme-generator description: Generate professional README.md files for projects. Use when asked to create, update, or improve README documentation, extract project metadata, or suggest README structure and content.

README Generator Skill

The agent can assist with the following tasks:

README Creation

  • •Generate a new README.md with standard sections
  • •Extract project metadata (name, author, license, etc.)
  • •Suggest badges and shields

Content Assistance

  • •Write clear descriptions and usage examples
  • •Suggest installation and setup instructions
  • •Recommend best practices for documentation

Customization

  • •Tailor README sections to project type (library, app, API, etc.)
  • •Add custom sections as requested

Example Usage

  • •"Create a README.md for my Python project."
  • •"Update the usage section in my README."
  • •"Suggest badges for my open-source repo."