SuperAPI AI 工具集

entry-docs

写作与研究

查看项目

更新于 10-16 03:43

技能介绍

Entry Docs 是一个面向仓库入口文档的技能,目标是产出或改进两类入口文件:README.md 面向决定是否以及如何使用项目的人类读者;AGENTS.md 是面向编码智能体的规范入口文件,Claude Code 在路径上没有 CLAUDE.md 时会直接读取它,而 CLAUDE.md 仅存在于 Claude Code 的加载引用中,不作为第二套规则正文。两者共享形态而非同一模板,应尽可能简短,深度内容放在指针之后,二者互补而非镜像,仅一句话项目描述是预期的唯一重叠。

主要模式有三种:Author(创建或重写指定文件)、Refactor(按 references/agents-md.md 中的 Refactor order 通过渐进式披露拆分臃肿的 AGENTS.md)、Diagnose(按各门槛审查,除非被要求否则不改写)。起草前需检查仓库:已有入口文件、包管理器、脚本、许可证、公共接口以及 CI/lint 配置;若涉及 AGENTS.md 或 CLAUDE.md,还需盘点仓库内所有指令文件(各级 AGENTS.md 与 CLAUDE.md、.claude/CLAUDE.md、CLAUDE.local.md、.claude/rules/,以及 .cursor/rules/、.cursorrules、.github/copilot-instructions.md、GEMINI.md、AGENTS.override.md)。不得编造项目事实;文件正文语言与仓库现有文档一致,新建且未标注时用英语。

门槛包括:Audience Gate(每个纳入文件须有明确受众,每个保留块须有归属位置,禁止用同一模板套两个文件、把 README 内容放进 AGENTS.md、在 README 写智能体指令、互相摘要或合并成一份);Placement Gate(规定根 AGENTS.md、嵌套 AGENTS.md、链接文档或技能、README.md 各承担什么,以及应删除的冗余内容);Budget Gate(根内容须满足 Placement 根行与 every-task 测试,须跨全部指令文件做矛盾与删除检查);Funnel Gate(README 须满足漏斗顺序与完整性清单,关键限制说明须出现在安装之前)。输出包含 Artifacts、Placement map、Pair check、Decisions needed、Gaps。不适用范围包括工作文档文件夹、决策账本、ADR 迁移,以及不满足 every-task 测试的多段式根规则模板。具体命令、文件路径与完整代码示例请以原文为准。