用途:根据当前代码库状态更新项目 README.md,输出较完整的项目文档,适用于 README 需要更新或已过时的情况。
主要能力:先分析项目结构与状态,包括列出根目录文件以判断项目类型(Node.js、Python 等),读取关键配置文件(如 package.json、tsconfig.json、shopify.app.toml、fly.toml、requirements.txt、Gemfile、cargo.toml),并查看有效源代码目录(如 app/、src/、lib/、components/)以理解架构。随后读取现有 README.md,保留用户手动添加的章节或特定说明;如存在 .agent/brain/task.md 或 implementation_plan.md 也会读取以了解近期变更和现有功能(此项可选,缺失不报错)。最后重写 README.md,按项目类型适配地包含以下章节:项目标题与描述、功能、技术栈、前置要求、快速开始/安装、项目结构、工作流与技能(如相关)、许可证(若存在许可证文件)。完成后进行复核:确保 Markdown 格式正确,并检查链接是否有效。
使用方式:作为技能/工作流调用,触发场景为 README 需要更新或过时。
适用场景:项目文档长期未同步、新增功能未记录、需要按代码现状重建 README 时。
限制:资料未提供具体调用命令、安装步骤、平台限制、收费或价格信息,暂未提供。该技能不保证推断出的功能完全准确,需人工复核链接与手动保留章节。