README Generator_AI Agent skill-PHP中文网

README Generator

Polar Sponsor

爱发电赞助

.NET 9.0

立即下载

分析项目结构、框架和代码，生成生产级README.md

校验生成器 – 生产- 质量 README 生成器

功能概述

校验生成器 – 生产- 质量 README 生成器是一项面向实际任务的技能，主要用于分析项目的结构,并生成一个全面的、框架性 README. md.；Steps.；

核心要点

Analysis Project Structure.；
Read these files (if)。
它将相关步骤、工具调用和结果整理方式集中到统一流程中，帮助使用者更快完成目标并减少重复操作。

使用与执行

使用时应结合输入条件选择合适的执行方式，核对必要参数、依赖环境与输出内容，并按原始要求处理异常情况。从功能定位来看，该技能强调把分散的操作要求整理成清晰、可复用的处理流程，使用户能够围绕既定目标快速准备输入、选择执行方式并获得结构化结果。实际使用前应先确认任务范围、数据来源、运行环境、必要权限和关键参数，再依据技能说明逐步执行；若输入条件不完整，应先补齐信息或采用保守配置，避免因错误假设导致结果偏离需求。

结果检查与注意事项

执行过程中需要关注工具调用是否成功、接口或依赖是否可用、输出格式是否符合预期，并对异常提示、缺失字段和边界情况进行处理；涉及批量任务时，还应保存进度，避免中断后重复操作。该技能适合用于一次性任务，也可以接入自动化工作流，与其他技能或上层代理配合完成更完整的业务链路；在组合使用时，应明确每一步的输入输出关系，并避免不同步骤之间出现参数冲突。

readme-generator — 生产级 README 生成器

分析项目结构，并生成一份全面、框架感知的 README.md。

步骤

1. 分析项目结构

读取以下文件（若存在）：

package.json / pyproject.toml / Cargo.toml / go.mod — 名称、描述、版本、依赖项
tsconfig.json — TypeScript 配置
docker-compose.yml / Dockerfile — 容器化配置
.github/workflows/ — CI/CD 流水线
LICENSE / LICENSE.md — 许可证类型
入口文件： src/index.*、src/main.*、app.*、main.*、index.*
tests/ / test/ / __tests__/ / spec/ — 测试配置

# 获取文件树（深度为 3，忽略常见目录）
find . -maxdepth 3 -not -path '*/node_modules/*' -not -path '*/.git/*' -not -path '*/dist/*' -not -path '*/__pycache__/*' | head -100
# Windows 替代命令：
Get-ChildItem -Recurse -Depth 3 -Exclude node_modules,.git,dist,__pycache__ | Select-Object -First 100 FullName

2. 检测框架与技术生态

检测信号	对应框架
`next.config.*` 或依赖中含 `"next"`	Next.js
依赖中含 `"express"`	Express.js
依赖中含 `"fastapi"`	FastAPI
依赖中含 `"django"`	Django
依赖中含 `"flask"`	Flask
依赖中含 `"react"`（且不含 `"next"`）	React（CRA/Vite）
依赖中含 `"vue"`	Vue.js
依赖中含 `"svelte"`	SvelteKit
`Cargo.toml` 中含 `[[bin]]` 段	Rust CLI
`Cargo.toml` 中含 `actix-web`/`axum`	Rust Web
`go.mod`	Go

3. 确定安装与运行命令

依据检测到的技术生态确定：

Node.js：检查锁文件以判断包管理器。

pnpm-lock.yaml → pnpm install / pnpm dev
yarn.lock → yarn / yarn dev
package-lock.json → npm install / npm run dev
读取 package.json 中的 scripts 字段获取可用命令。

Python：检查 pip、poetry、pipenv 的使用情况。

poetry.lock → poetry install / poetry run ...
Pipfile → pipenv install / pipenv run ...
requirements.txt → pip install -r requirements.txt

Rust： cargo build / cargo run

Go： go build / go run .

4. 生成徽章（Badges）

根据检测到的工具构建徽章 URL：

![License](https://img.shields.io/badge/license-MIT-blue.svg)
![Node](https://img.shields.io/badge/node-%3E%3D18-brightgreen)
![TypeScript](https://img.shields.io/badge/TypeScript-5.x-blue)

仅包含实际检测到的内容对应的徽章。常见徽章包括：许可证、语言/运行时版本、CI 状态、测试覆盖率。

5. 组装 README

采用如下结构：

# Project Name

来自 package.json/pyproject.toml 的简要描述，或从代码中推断得出。

## Table of Contents
- [Features](#features)
- [Prerequisites](#prerequisites)
- [Installation](#installation)
- [Usage](#usage)
- [API Reference](#api-reference)  ← 如适用则添加
- [Configuration](#configuration)  ← 如检测到环境变量则添加
- [Testing](#testing)
- [Deployment](#deployment)  ← 如检测到 Docker/CI 则添加
- [Contributing](#contributing)
- [License](#license)

## Features
- 关键能力要点列表（基于代码结构、路由、导出内容推断）

## Prerequisites
- 运行时版本（如 node >= 18、python >= 3.10 等）
- 所需系统工具（Docker、数据库等）

## Installation
[第 3 步中确定的、对应包管理器的安装命令]

## Usage
[开发/启动命令；若为服务端项目，补充示例 API 调用]

## API Reference
[仅适用于库/API 项目 — 列出导出的函数或端点]

## Configuration
[环境变量说明 — 若较复杂，可参考 env-setup 技能]

## Testing
[测试运行命令：npm test、pytest、cargo test 等]

## Contributing
1. Fork 仓库
2. 创建特性分支（git checkout -b feat/amazing-feature）
3. 提交更改（git commit -m 'feat: add amazing feature'）
4. 推送至分支（git push origin feat/amazing-feature）
5. 提交 Pull Request

## License
[检测到的许可证，或写“See LICENSE file”]

6. 按框架定制内容

Next.js：补充 pages/app router、API routes、环境变量相关章节
Express/FastAPI：记录路由结构、中间件、API 端点
React/Vue：记录组件结构、状态管理方式、构建产物说明
CLI 工具：记录命令行参数与标志位（flags）
库（Libraries）：聚焦 API 文档、安装方式及使用示例

7. 输出

将生成结果写入项目根目录下的 README.md。若该文件已存在，则先询问用户是否覆盖；并提供备选方案：写入 README.generated.md。

边界情况处理

单体仓库（Monorepo）：生成根目录 README，链接至各子包；同时为每个子包生成独立 README
空项目：生成最小骨架 README，并标注 TODO 占位符
无包清单文件（package manifest）：依据文件扩展名与目录结构推断项目类型
已有 README：覆盖前主动询问；对比差异并建议补充内容

错误处理

错误	应对策略
无法识别框架	生成通用型 README；提示用户手动指定
无可用描述信息	使用目录名作为默认描述；提示用户补充
缺少许可证文件	注明缺失；建议添加许可证
项目规模过大	限制文件树扫描深度；聚焦 `src/` 目录与根目录配置文件