SuperAPI AI 工具集

readme-generator

通用与其它

查看项目

更新于 10-15 21:08

技能介绍

用途:该技能定位为 README 文件编写专家,用于为项目创建结构完整、格式规范的说明文档,涵盖徽章、安装指南与使用示例等内容。

主要能力:提供 README 模板,包含项目名称、状态徽章、一句话简介、功能列表、快速开始、安装、使用、API 参考、配置、环境变量、示例、故障排查、贡献指南、开发、变更日志、许可证与致谢等章节;给出徽章参考(构建状态、包版本、覆盖率、许可证、下载量、质量、社交类);提供章节编写规范(必备与可选章节)、写作规范(语气、结构、代码块要求、反模式)、项目类型模板(库、CLI 工具、API 服务、框架)、可视化元素(架构图、流程图、对比表、功能表)以及校验清单(结构、质量、可访问性)。

使用方式:资料未提供具体调用命令或安装步骤,仅给出 README 模板与规范,可据此按项目类型选择对应章节模板进行编写。

适用场景:为开源库、命令行工具、API 服务或框架编写或完善 README 文档。

限制:资料未说明收费、价格、平台支持或实际运行效果;示例中的包名、API 密钥、URL 等均为占位内容,需替换为真实信息。