SuperAPI AI 工具集

readme-blueprint-generator

智能体与模型

查看项目

更新于 10-16 09:56

技能介绍

用途:为仓库生成较完整的 README.md。它会分析 .github/copilot 目录中的文档与 .github/copilot-instructions.md,据此组织项目介绍、技术栈、架构、快速开始、目录结构、主要功能、开发流程、编码规范、测试、贡献指南和许可证等章节。

主要能力:扫描 Architecture、Code_Exemplars、Coding_Standards、Project_Folder_Structure、Technology_Stack、Unit_Tests、Workflow_Analysis 等文档文件;从 Technology_Stack 提取语言、框架与版本信息;从 Architecture 提取架构概览并可在有描述时加入简单图示;从 Coding_Standards、Unit_Tests、Workflow_Analysis 分别整理规范、测试方式与开发流程;从 Code_Exemplars 和 copilot-instructions 生成贡献指南。

使用方式:在项目中使用该提示词,要求为仓库生成 README.md;提示词会读取上述文档后输出带标题层级、代码块、列表、文档链接及可用徽章的 Markdown。前提是相关文档已存在且内容准确。

适用场景:已有较完善 Copilot 文档的仓库,需要快速产出面向新开发者或用户的说明文档。

限制:仅基于指定文档内容生成,信息缺失时相应章节可能不完整;未提供许可证、徽章信息时不会自行补充;官方未说明具体平台、安装命令、收费或效果,暂未提供。