SuperAPI AI 工具集

readme

写作与研究

查看项目

更新于 10-15 14:47

技能介绍

用途

/readme 是一个用于生成或改进 README 文档的技能,目标产出一份既能吸引快速浏览者转化为用户、又能满足深度阅读者的 README,并通过 council 进行验证。

主要能力

  • 支持三种模式:
    • /readme:访谈 + 生成 + 验证(新 README)
    • /readme --rewrite:用相同模式重写现有 README
    • /readme --validate:仅对现有 README 进行 council 验证,不重写
  • 遵循八条“黄金标准”模式:
    1. 以问题开头,而非框架
    2. 承认已有实践
    3. 展示而非声称
    4. 差异化只陈述一次
    5. 在安装命令附近提供信任说明块
    6. 折叠深度内容而非删除
    7. 去除“大师”语气
    8. 章节顺序服务于采用
  • 自动检测并标记反模式,如核心价值重复、框架优先、术语未定义、信任信息被埋没、缺少卸载说明、安装命令分散、理论先于尝试、无证据的声称等。
  • 生成后调用 council 技能进行验证,支持快速验证或完整验证(2 位评审)。

使用方式

执行 /readme 后,技能会:

  1. 预检:检查是否存在 README.md,并根据标志和文件存在情况决定模式。
  2. 收集上下文:静默读取项目文件(如 README.md、PRODUCT.md、package.json、pyproject.toml、go.mod、Cargo.toml、Makefile、LICENSE 等),提取项目名称、语言/运行时、描述、许可证、安装方式。
  3. 访谈:通过 AskUserQuestion 询问问题、解决方案、目标用户、安装命令、快速演示、信任关注点、已有实践等。
  4. 生成 README:按照指定结构和八条模式生成 README,写入 README.md。
  5. Council 验证:调用 council 技能验证 README 的清晰度、非重复性以及对两类读者的服务能力。
  6. 应用修复(如请求):根据 council 建议修复并重新快速验证。
  7. 报告:输出文件、章节数、应用的模式、council 结论。

适用场景

  • 为新项目从零生成 README。
  • 重写现有 README 以符合黄金标准模式。
  • 仅验证现有 README 并获取 council 报告。

限制

  • 依赖 /council 技能进行验证;若未安装或损坏,验证步骤可能失败或挂起,需运行 /update 重装。
  • 信任说明块仅在访谈中选择了信任关注点时生成;若未选择但实际存在相关行为,需重新运行并选择。
  • <details> 块在 GitHub 上渲染为原始 HTML 通常是因为缺少 <summary> 后或 </details> 前的空行;技能会强制此格式,但手动编辑可能破坏。
  • 访谈可能重复询问项目清单已能回答的问题,若清单格式不被识别;需确保项目根目录有标准清单文件。
  • 反模式检测为启发式,可能对有意为之的内容产生误报,需在 council 步骤中人工判断。

相关技能

  • skills/product/SKILL.md — PRODUCT.md 生成(为 README 提供上下文)
  • skills/doc/SKILL.md — 代码文档(范围不同,API 文档而非 README)
  • skills/council/SKILL.md — 第 5 步使用的验证引擎