SuperAPI AI 工具集

create-llms

写作与研究

查看项目

更新于 10-15 16:15

技能介绍

用途

create-llms 用于在仓库根目录从零创建一个 llms.txt 文件,遵循 https://llmstxt.org/ 的官方规范。该文件为大型语言模型(LLM)提供高层级指引,说明在何处可以找到理解仓库用途与规范的相关内容。

主要能力

  • 审阅 llms.txt 官方规范,确保完全合规,理解所需格式结构与指南。
  • 分析完整仓库结构,识别仓库的主要用途与范围,编目重要目录及其用途,列出对 LLM 理解有价值的关键文件。
  • 进行内容发现:定位 README 文件、文档文件(如 /docs/、/spec/ 下的 .md 文件)、规范文件、配置文件、示例文件与代码样例,以及现有文档结构。
  • 制定实施计划:包括仓库用途与范围摘要、按优先级排序的 LLM 理解必需文件清单、提供额外上下文的次要文件、llms.txt 的组织结构。
  • 创建并校验 llms.txt 文件,确保格式合规、链接有效、内容清晰。

使用方式

该技能按以下阶段执行:

  1. 分析与规划阶段:审阅 llms.txt 规范;分析仓库结构;发现内容;创建实施计划。
  2. 执行步骤:仓库分析(完整检查结构、阅读主 README.md、识别文档目录与文件、编目规范文件、查找示例与配置文件);内容规划(确定主要用途陈述、撰写引用块摘要、将文件分组到逻辑类别、按重要性排序、为每个文件链接创建描述);文件创建(在仓库根目录创建 llms.txt,遵循精确格式规范,包含所有必需分区,使用正确 markdown 格式,确保所有链接为有效相对路径);校验(验证符合 https://llmstxt.org/ 规范、检查链接有效可访问、确保文件是有效的 LLM 导航工具、确认文件同时适合人类与机器阅读)。

格式要求

llms.txt 必须遵循以下结构:

  • H1 标题:单行,包含仓库/项目名称(必需)。
  • 引用块摘要:以 blockquote 格式给出简要描述(可选但推荐)。
  • 附加细节:零个或多个无标题的 markdown 段落,用于提供上下文。
  • 文件列表分区:零个或多个 H2 分区,包含 markdown 链接列表。

文件链接格式为:描述名: 可选说明。

分区可按逻辑组织,例如:Documentation(核心文档文件)、Specifications(技术规范与需求)、Examples(示例代码与用法)、Configuration(设置与配置文件)、Optional(次要文件,可跳过以缩短上下文)。

内容准则

  • 使用简洁、清晰、无歧义的语言,避免未解释的术语,面向人类与 LLM 读者写作,描述具体且信息丰富。
  • 应包含的文件:解释仓库用途与范围、提供必要技术文档、展示用法示例与模式、定义接口与规范、包含配置与设置说明。
  • 应排除的文件:纯实现细节、冗余信息、构建产物或生成内容、与理解项目无关的内容。

适用场景

适用于需要为仓库创建 llms.txt 入口文件的场景,使 LLM 能快速理解仓库用途、获得对关键文档的清晰导航,并遵循官方 llms.txt 规范。

限制

资料未提供该技能的具体安装命令、运行环境、依赖项、收费或价格信息,暂未提供。