---
name: yangge521/readme-generator
source: https://app.decimal.ai/s/yangge521-readme-generator@1/SKILL.md
source_sha256: 87ca36ae5d74
---

# 中文 README 自动生成

## 概述

自动生成高质量中文 README，包含项目徽章、目录结构、安装说明、使用示例、架构图、贡献指南等标准模块。

## 使用场景

- 新项目初始化：快速生成 README
- 开源项目发布：专业 README 吸引 Star
- 项目文档更新：README 与代码同步
- GitHub 项目展示：提升项目形象
- 内部项目文档：团队内部项目说明
- 技能包文档：SKILL.md 辅助文档

## README 标准结构

1. 标题 + 徽章（License/版本/Star）
2. 项目简介（一句话说明）
3. 功能特性（表格或列表）
4. 快速安装（多种方式）
5. 使用示例（代码 + 效果）
6. 项目结构（目录树）
7. 配置说明
8. 常见问题 FAQ
9. 贡献指南
10. 开源协议
11. Star 历史

## 常见问题与排查

| 问题 | 原因 | 解决方案 |
|------|------|---------|
| 徽章不显示 | URL 错误 | 使用 shields.io 标准格式 |
| 目录结构过时 | 代码变更未更新 | CI 检查目录同步 |
| 安装步骤不通 | 环境差异 | 补充前置条件说明 |
| 图片不显示 | 路径错误 | 使用相对路径 |

## 扩展方向

- **AI 生成**: AI 分析代码自动生成 README
- **模板系统**: 多套 README 模板可选
- **多语言**: 中英文双 README
- **交互式**: README 中嵌入在线 Demo
- **自动化**: Git hook 自动更新 README
- **SEO 优化**: 优化 GitHub 搜索排名

## 技能链路

- **code-comment-cn**: 从代码注释提取信息
- **tech-doc-cn**: README 链接到详细文档
- **git-workflow**: README 随代码版本更新
- **pr-template-cn**: PR 中检查 README 更新

## 检查清单

- [ ] 徽章显示正确
- [ ] 安装步骤可执行
- [ ] 使用示例可运行
- [ ] 目录结构与代码一致
- [ ] 开源协议已标注