用途:本技能用于为项目创建或审计 README.md,在新建项目、审查缺失章节、统一多项目 README 格式、添加 shields.io 徽章或技术栈表格时使用。不适用于编辑局部内容、撰写详细 API 文档(用 /configure:docs)、搭建 GitHub Pages(用 /configure:github-pages)或编写 changelog。
主要能力:从 package.json、pyproject.toml、Cargo.toml、go.mod 检测名称、描述、版本、许可证、仓库、关键词;扫描现有 README 的章节完整性并输出 PASS/MISSING/PARTIAL 合规报告;按风格模板生成 README,包含居中 logo、标题、徽章行、功能、技术栈表格、快速开始、项目结构、开发命令、贡献与许可证;自动探测安装/运行/测试/构建命令;用 tree -L 2 -I 'node_modules|target|pycache|.git|dist|build' --dirsfirst 生成结构;更新 .project-standards.yaml;生成后校验 Markdown 语法、链接与图片路径。
使用方式:参数包括 --check-only(仅报告,可用于 CI/CD)、--fix(自动修复)、--style <minimal|standard|detailed>(默认 standard)、--badges <shields|custom>(默认 shields)、--no-logo。常用命令:/configure:readme --check-only、/configure:readme --fix、/configure:readme --fix --style minimal、/configure:readme --fix --style detailed。风格级别:minimal 含标题、描述、徽章、基础安装用法;standard 增加 logo、功能、技术栈、快速开始、许可证;detailed 再加架构图、API 参考、贡献指南、changelog 链接。
适用场景:项目初始化、README 合规审计、跨项目格式统一、CI 中做只读检查。
限制:资料未提供内置模板细节、徽章 URL 具体写法及参数默认值以外配置;logo 缺失时仅建议用文本占位或 emoji,未提供自动生成图像能力;链接校验仅告警;详细模板见 REFERENCE.md。