README 蓝图生成
原名:readme-blueprint-generator
根据项目文件和现有文档生成结构清楚、与代码一致的 README。
中文 Skills 技能说明
适合新仓库补充说明或旧 README 已经失真时使用。安装命令、环境变量、目录和示例必须从项目核验,真实密钥只写配置方法;修改前保留已有风格和有效内容。
上游能力依据
上游原始适用说明: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.
上游 SKILL.md 主要章节(保留原文标题):
- Project Name and Description
- Technology Stack
- Project Architecture
- Getting Started
- Project Structure
- Key Features
- Development Workflow
- Coding Standards
- Testing
- Contributing
使用边界
先提供真实业务背景、目标受众和可核验资料。输出是工作草稿或决策辅助,不补造客户反馈、经营数据、案例或引用。
作者、翻译与许可证
- 原作者
- GitHub, Inc. 与 awesome-copilot contributors
- 中文翻译
- CEOFans翻译
- 许可证
- MIT
- 上游来源
- https://github.com/github/awesome-copilot/tree/3f0bba475ec40b9680e1d0311b9caffeec5ad4c3/skills/readme-blueprint-generator
适用范围
平台:linux、macos、windows;标签:内容与写作、README 蓝图生成
安全提示
基础静态扫描不等于绝对安全。技能可能调用命令、浏览器、云服务或本地文件,请在最小权限环境中使用,高风险操作必须人工确认。
如发现侵权、许可证或安全问题,可在本页前台提交投诉,管理员复核后可立即下架。