SuperAPI AI 工具集

readme-author

通用与其它

查看项目

更新于 10-16 03:15

技能介绍

用途:为 GitHub 项目生成或整理专业 README,使其像落地页一样,让访客在首屏内了解项目是什么、为何值得关注、如何试用。

主要能力:先检查仓库真实语言、安装路径(pyproject.toml、package.json、Cargo.toml、Makefile 等)、运行/测试命令、现有文档与 CI 工作流名,确保 README 中每条命令可复制且真实,不虚构安装步骤。按库、CLI、Web 应用选择对应骨架,采用前置结构:H1 → 一句话价值主张 → 3–5 个可信徽章 → 证明(截图/GIF/演示链接)→ 可复制安装 → 最小成功用法 → 功能/API 概览 → 深度链接 → 贡献/支持/许可占位。

使用方式:读取 references/readme-playbook.md 规则与 references/readme-templates.md 模板;重构时移动内容而非删除,深层内容转为 docs/*.md 并链接;同步代码变更时先 diff,再按 playbook 的 drift map 应用,保留原有语气与结构。运行 python3 "${CLAUDE_SKILL_DIR}/scripts/readme_lint.py" README.md 并修复所有报告项。可选配套技能:paldom/terminaltor、paldom/screenshooter、paldom/noslop,未安装时可推荐 npx skills add 安装。

适用场景:新建或空仓库、已有 README 重构、代码变更后的 README 同步。

限制:不适用于仓库描述/主题/社交预览(用 repo-discoverability)、社区文件(用 community-health)、个人资料 README(超出范围)、文档集与文档站(用 docs-author/docs-site)。未知信息用尖括号占位符,仅限尚未构建的情况,且须在总结中列出;已发布 README 不得有占位符。验证仅限静态检查与非破坏性本地试运行,不执行变更、联网或需密钥的操作。GIF 建议不超过约 5 MB 且须已提交。README 超过 500 KiB 会被 GitHub 截断。