技能库智客分类：文档办公 readme-blueprint-generator

Readme Blueprint Generator

Intelligent README.md 生成提示分析项目文件结构并创建全面的存储器文件. 扫描.github/副驾驶目录文件和副驾驶指示. md可以提取项目信息,技术堆栈,架构,开发工作流程,编码标准和测试方法,同时生成结构完善的标出文件,并有适当的格式,交叉参考,以及开发者集中的内容.

9660 安装量

官方网址：skills.sh

技能介绍

先看中文介绍；官方 description 原文单独保留，不改写 SKILL.md。

做什么

何时用

官方 description 未单独写出 Use when。按规范，代理会在用户任务与这段 description 的关键词匹配时激活本技能。

代理如何加载

按 Agent Skills 渐进披露：启动时只加载 name 与 description（约 100 token）；任务匹配后才读入整份 SKILL.md 正文；scripts/、references/、assets/ 仅在需要时再读。本文件正文结构：README Generator Prompt、Project Name and Description、Technology Stack、Project Architecture、Getting Started、Project Structure。其中含规范建议的小节：分步指令。

文件分析

文件分析：这是一份仅含 SKILL.md 的指令型技能，代理激活后整份正文进入上下文。

官方 description（原文）

Intelligent README.md generation prompt that analyzes project documentation structure and creates comprehensive repository documentation. Scans .github/copilot directory files and copilot-instructions.md to extract project information, technology stack, architecture, development workflow, coding standards, and testing approaches while generating well-structured markdown documentation with proper formatting, cross-references, and developer-focused content.

README Generator PromptProject Name and DescriptionTechnology StackProject ArchitectureGetting StartedProject StructureKey FeaturesDevelopment WorkflowCoding StandardsTestingContributingLicense

来源分类：skills.sh agent-skill

来源与网址

市场来源：skills.sh

GitHub 完整包

开源榜 Skill 分类

SKILL.md 与 Agent 调用

官方规范 ↗

name: readme-blueprint-generator
description: Intelligent README.md generation prompt that analyzes project documentation structure and creates comprehensive repository documentation. Scans .github/copilot directory files and copilot-instructions.md to extract project information, technology stack, architecture, development workflow, coding standards, and testing approaches while generating well-structured markdown documentation with proper formatting, cross-references, and developer-focused content.

发现技能客户端向 Agent 提供名称与描述目录。
匹配与调用用户指定或任务匹配后，载入 SKILL.md 指令。
按需加载按步骤读取参考文档、使用脚本与素材。

具体调用语法与可用工具以目标 Agent 客户端为准。查看调用机制说明 ↗

安装这个技能

Skills CLI ↗

先选择目标 Agent 和安装范围，保留技能包的附属文件，安装后检查客户端能否发现该技能。

交给 Agent 安装

复制安装指令给支持 Agent Skills 的代理，确认其中的目标目录与客户端匹配。

把 Agent Skill「readme-blueprint-generator」安装到我的项目：SKILL.md 原文与官方 description 见 https://zicq.com/zh/skills/skl-724dca49c168598d-Readme-Blueprint-Generator.html
请存为 .cursor/skills/readme-blueprint-generator/SKILL.md 或 .claude/skills/readme-blueprint-generator/SKILL.md，frontmatter 的 name 与 description 保持原样，不要改写。

GitHub 完整包 ↗

终端安装 · Skills CLI

需要 Node.js 与 npx。先查看仓库技能列表，确认实际名称。

npx skills add 'https://github.com/github/awesome-copilot' --list

目标客户端安装范围

npx skills add 'https://github.com/github/awesome-copilot' --skill 'readme-blueprint-generator'

CLI 会交互选择目标 Agent，默认安装到项目；用户级安装使用 -g。先通过查看命令核对仓库内容，再用 npx skills list 检查已安装技能。

SKILL.md 原文可复制，不会改动源文件

---
name: readme-blueprint-generator
description: 'Intelligent README.md generation prompt that analyzes project documentation structure and creates comprehensive repository documentation. Scans .github/copilot directory files and copilot-instructions.md to extract project information, technology stack, architecture, development workflow, coding standards, and testing approaches while generating well-structured markdown documentation with proper formatting, cross-references, and developer-focused content.'
---

# README Generator Prompt

Generate a comprehensive README.md for this repository by analyzing the documentation files in the .github/copilot directory and the copilot-instructions.md file. Follow these steps:

1. Scan all the files in the .github/copilot folder, like:
   - Architecture
   - Code_Exemplars
   - Coding_Standards
   - Project_Folder_Structure
   - Technology_Stack
   - Unit_Tests
   - Workflow_Analysis

2. Also review the copilot-instructions.md file in the .github folder

3. Create a README.md with the following sections:

## Project Name and Description
- Extract the project name and primary purpose from the documentation
- Include a concise description of what the project does

## Technology Stack
- List the primary technologies, languages, and frameworks used
- Include version information when available
- Source this information primarily from the Technology_Stack file

## Project Architecture
- Provide a high-level overview of the architecture
- Consider including a simple diagram if described in the documentation
- Source from the Architecture file

## Getting Started
- Include installation instructions based on the technology stack
- Add setup and configuration steps
- Include any prerequisites

## Project Structure
- Brief overview of the folder organization
- Source from Project_Folder_Structure file

## Key Features
- List main functionality and features of the project
- Extract from various documentation files

## Development Workflow
- Summarize the development process
- Include information about branching strategy if available
- Source from Workflow_Analysis file

## Coding Standards
- Summarize key coding standards and conventions
- Source from the Coding_Standards file

## Testing
- Explain testing approach and tools
- Source from Unit_Tests file

## Contributing
- Guidelines for contributing to the project
- Reference any code exemplars for guidance
- Source from Code_Exemplars and copilot-instructions

## License
- Include license information if available

Format the README with proper Markdown, including:
- Clear headings and subheadings
- Code blocks where appropriate
- Lists for better readability
- Links to other documentation files
- Badges for build status, version, etc. if information is available

Keep the README concise yet informative, focusing on what new developers or users would need to know about the project.

阅读排版

name: readme-blueprint-generator description: 'Intelligent README.md generation prompt that analyzes project documentation structure and creates comprehensive repository documentation. Scans .github/copilot directory files and copilot-instructions.md to extract project information, technology stack, architecture, development workflow, coding standards, and testing approaches while generating well-structured markdown documentation with proper formatting, cross-references, and developer-focused content.'

README Generator Prompt

Generate a comprehensive README.md for this repository by analyzing the documentation files in the .github/copilot directory and the copilot-instructions.md file. Follow these steps:

Scan all the files in the .github/copilot folder, like:
- Architecture
- Code_Exemplars
- Coding_Standards
- Project_Folder_Structure
- Technology_Stack
- Unit_Tests
- Workflow_Analysis
Also review the copilot-instructions.md file in the .github folder
Create a README.md with the following sections:

Project Name and Description

Extract the project name and primary purpose from the documentation
Include a concise description of what the project does

Technology Stack

List the primary technologies, languages, and frameworks used
Include version information when available
Source this information primarily from the Technology_Stack file

Project Architecture

Provide a high-level overview of the architecture
Consider including a simple diagram if described in the documentation
Source from the Architecture file

Getting Started

Include installation instructions based on the technology stack
Add setup and configuration steps
Include any prerequisites

Project Structure

Brief overview of the folder organization
Source from Project_Folder_Structure file

Key Features

List main functionality and features of the project
Extract from various documentation files

Development Workflow

Summarize the development process
Include information about branching strategy if available
Source from Workflow_Analysis file

Coding Standards

Summarize key coding standards and conventions
Source from the Coding_Standards file

Testing

Explain testing approach and tools
Source from Unit_Tests file

Contributing

Guidelines for contributing to the project
Reference any code exemplars for guidance
Source from Code_Exemplars and copilot-instructions

License

Include license information if available

Format the README with proper Markdown, including:

Clear headings and subheadings
Code blocks where appropriate
Lists for better readability
Links to other documentation files
Badges for build status, version, etc. if information is available