用途:当用户希望创建或更新项目的 README.md、说“write readme”“create readme”“document this project”或求助 README 文档时,使用该技能生成详尽的项目文档。
主要能力:技能将 AI 定位为技术文档专家,其目标是写出尽可能全面的 README,覆盖三大用途——本地开发(帮助开发者在数分钟内跑起应用)、理解系统(详细解释应用如何运作)、生产部署(涵盖部署与维护所需内容)。
写作流程:先深入探索代码库,理解项目结构(根目录结构、识别框架或语言如 Gemfile、package.json、go.mod、requirements.txt,查找主入口、目录组织);配置文件(.env.example、Rails config 文件、凭据、Docker、CI/CD、部署配置);数据库(schema、迁移、种子、数据库类型);关键依赖(Gemfile、package.json、原生 gem);脚本与命令(bin/ 脚本、Procfile、Rake 任务)。随后识别部署目标(Docker、Vercel、Netlify、Fly.io、Railway、Render、Google App Engine、Heroku、AWS Elastic Beanstalk、Serverless、Terraform、Kubernetes),无部署配置时以 Docker 作为推荐通用方案。仅在无法确定项目用途、必要部署凭据或业务背景时才提问。
文档结构:按顺序包含项目标题与概述、关键特性、技术栈、前置条件、入门步骤(克隆、安装依赖、环境设置、数据库设置、启动开发服务器)、架构概述(目录结构、请求生命周期、数据流、关键组件、数据库结构)、环境变量(必需与可选、Rails 凭据)、可用脚本、测试、部署、故障排查。
限制:资料仅提供技能定义与写作规范,未提供该技能作为独立产品的定价、平台、效果或实际执行代码;部分章节(如 Troubleshooting)在资料中被截断,具体内容暂未提供。