SuperAPI AI 工具集

readme-craft

写作与研究

查看项目

更新于 10-15 10:49

技能介绍

readme-craft 是一个围绕 README.md 的创建与审计技能,来源为 acaprino/daodan。其核心目标是:从经过验证的项目事实出发,创建或审计 README.md,同时保留作者语气,并采用与信息重要性相称的信息架构。

用途 该技能可用于两种主要场景:一是仅审计(audit-only),对现有 README 及相关项目材料进行核查;二是在获得授权后创建或维护 README。它强调以事实为依据,避免编造内容。

主要能力 在审计模式下,技能会读取 README、清单文件(manifests)、许可证、已配置的脚本、相关入口点、公共接口、资源以及 CI。随后依据 references/audit-checklist.md 对范围内的每一项声明、计数、链接、徽章和命令进行核对。它会将已实现的功能与已批准的意图进行比较,而不是把当前代码当作产品需求。审计报告会包含证据位置、状态、保留的语气、错误声明、结构建议、未覆盖的表面以及无法执行的检查。审计模式只写入其负责的运行报告,不会更新 README、徽章、链接、文档或忽略规则。

在创建或维护模式下,技能优先沿用现有 README 及其有意的风格。只有在需要相关结构模式时,才会读取 references/layout-techniques.md。资料指出,一个项目可能只需要简单的介绍、安装说明和一个可运行的示例,而不需要宣传性声明、图片、徽章或社区链接。技能明确禁止虚构用户评价、性能声明、下载量、包名或缺失的元数据。对于缺失的重要选择,仅在必要时询问;可选的装饰性内容可以省略。技能会遵循计划中的文件和范围;完整重构需要获得允许该操作的授权范围。

使用方式 技能会加载 project-protocol:project-protocol 以及项目知识方法,用于运行归属、输入准备和授权应用。它接收范围、快照、现有 README、读者、模式、输出路径和授权信息。技能使用项目已验证的脚本和安装约定,并区分“复制的命令”与“实际执行过的命令”。对于已接受的发现,通过项目知识的 apply-method 进行修正,同时保留事实、作者语气和入站链接。如果请求进行文字润色,则加载 text-humanizer:anti-ai-writing-patterns,并在文档登记中调度 text-humanizer:text-humanizer。新的或保留的缺口与检查会在同一次运行中记录,不会在 README 中重现会话日志。

适用场景 适用于需要基于事实创建 README 的项目,或需要对现有 README 进行审计、核对声明与链接、检查命令与徽章、评估结构合理性的场景。也适用于在保留作者语气的前提下维护或润色 README 文档。

限制 仅审计模式不会更新 README、徽章、链接、文档或忽略规则。完整重构需要获得授权范围。技能不会编造用户评价、性能声明、下载量、包名或缺失的元数据。关于收费、价格、平台支持等具体信息,资料中暂未提供。