AI Skills
create-llms

create-llms

热门

根据 https://llmstxt.org/ 上的 official llms.txt 规范，结合代码库结构从零生成 llms.txt 文件。

3.6万Star
4556Fork
更新于 2026/7/13
获取 Skill源代码

相关 Skills

academy-guide17万write-openspec-docs6.8万agent-reviewer7.1万
SKILL.md
只读
名称
create-llms
描述

根据 https://llmstxt.org/ 上的 official llms.txt 规范，结合代码库结构从零生成 llms.txt 文件。

根据代码库结构生成 llms.txt 文件

按照 https://llmstxt.org/ 的 official llms.txt 规范，在代码库根目录下从零创建一个全新的 llms.txt 文件。该文件为大语言模型（LLM）提供高阶导航，指引其快速找到理解代码库定位与技术规范的核心内容。

核心指令

生成一份内容详尽的 llms.txt 文件，作为 LLM 高效理解与检索代码库的统一入口。该文件必须严格符合 llms.txt 规范，既要为 LLM 的读取进行深度优化，又要保证人类开发者的良好可读性。

分析与规划阶段

在创建 llms.txt 文件前，必须先完成以下全面分析：

步骤 1：研读 llms.txt 规范

  • 仔细阅读 https://llmstxt.org/ 上的官方规范，确保完全合规
  • 掌握规定的格式结构与编写指南
  • 留意具体的 Markdown 结构要求

步骤 2：分析代码库结构

  • 使用适当的工具对代码库整体结构进行全面盘点
  • 明确代码库的核心定位与业务边界
  • 梳理所有核心目录及其作用
  • 列出有助于 LLM 理解项目的关键文件

步骤 3：挖掘核心内容

  • 查找 README 文件及其所在位置
  • 检索各类文档文件（如 /docs/、/spec/ 等目录下的 .md 文件）
  • 定位规范/协议文件并明确其用途
  • 梳理关键配置文件及其关联性
  • 收集示例文件与代码样例
  • 厘清现有的文档组织架构

步骤 4：制定执行方案

基于上述分析，制定一份结构化的执行方案，包含以下内容：

  • 代码库定位与业务边界摘要
  • 按重要程度排序的 LLM 必读文件清单
  • 提供补充上下文的次要文件清单
  • llms.txt 文件的目录组织结构

编写要求

格式规范

llms.txt 文件必须严格遵循官方规范定义的以下结构：

  1. H1 标题：独占一行，填写代码库/项目名称（必填）
  2. 引用块摘要：使用引用块（blockquote）格式简述项目（可选但强烈建议）
  3. 补充上下文：零个或多个无标题的 Markdown 段落，用于提供背景信息
  4. 文件列表章节：零个或多个包含 Markdown 链接列表的 H2 章节

内容要求

必备要素
  • 项目名称：清晰且具有描述性的 H1 标题
  • 项目摘要：概括代码库主要功能的精炼引用块
  • 核心文件：按分类组织的核心文件清单（H2 章节）
文件链接格式

每个文件链接必须遵循格式：[描述性名称](相对路径): 可选的说明文字

章节组织

将文件划分为逻辑清晰的 H2 章节，例如：

  • Documentation：核心文档文件
  • Specifications：技术规范与需求文档
  • Examples：示例代码与用法样例
  • Configuration：环境配置与项目设置文件
  • Optional：次要文件（具有特殊语义 —— 上下文超限时可优先忽略）

写作指南

语言与风格
  • 语言简洁、清晰、明确，无歧义
  • 避免使用未加解释的冷门术语
  • 兼顾人类开发者与 LLM 的阅读体验
  • 描述信息要具体且富有含金量
文件遴选标准

应当收录的文件：

  • 阐释代码库定位与业务边界的文件
  • 提供核心技术文档的文件
  • 展示示例代码与常见模式的文件
  • 定义接口契约与技术规范的文件
  • 包含环境配置与安装指南的文件

应当排除的文件：

  • 纯属具体实现细节的文件
  • 包含冗余信息的文件
  • 构建产物或自动生成的代码文件
  • 对理解项目主体毫无帮助的文件

执行步骤

步骤 1：分析代码库

  1. 深入梳理代码库的完整目录结构
  2. 阅读根目录下的 README.md，掌握项目全局
  3. 盘点所有文档目录及对应文件
  4. 整理各类规范/协议文件及其具体用途
  5. 找出示例代码与配置文件

步骤 2：规划文件内容

  1. 确定项目核心定位的描述一句话
  2. 撰写精炼的引用块摘要
  3. 将筛选出的文件归类到合理的逻辑章节中
  4. 按照对 LLM 理解的重要性进行优先级排序
  5. 为每个文件链接补充简明扼要的说明

步骤 3：生成目标文件

  1. 在代码库根目录下创建 llms.txt 文件
  2. 严格遵循官方格式规范
  3. 包含所有必要的章节与元素
  4. 使用标准且规范的 Markdown 语法
  5. 确保所有文件链接均为有效的相对路径

步骤 4：校验与确认

  1. 校验是否完全符合 https://llmstxt.org/ 官方规范
  2. 检查所有链接是否有效且路径正确
  3. 确认该文件能作为 LLM 的高效导航工具
  4. 确认内容对人类开发者和 LLM 都具有良好的可读性

质量检查清单

格式校验

  • ✅ 包含项目名称的 H1 标题
  • ✅ 引用块格式的项目摘要（如有）
  • ✅ 用于划分文件列表的 H2 章节
  • ✅ 标准的 Markdown 链接格式
  • ✅ 无失效或错误的相对路径
  • ✅ 全文排版与格式保持一致

内容校验

  • ✅ 表达清晰无歧义
  • ✅ 全面覆盖项目的核心关键文件
  • ✅ 内容分类与结构合理有序
  • ✅ 文件链接附带准确到位的说明
  • ✅ 能够作为 LLM 的高效导航工具

规范合规度

  • ✅ 严格符合 https://llmstxt.org/ 格式标准
  • ✅ 采用规范要求的 Markdown 结构
  • ✅ 合理运用可选章节（如 Optional 节点）
  • ✅ 文件存放在代码库根目录（/llms.txt）

示例结构模板

# [项目名称]

> [精炼的项目定位与业务边界说明]

[可选：无标题的补充上下文段落]

## Documentation

- [主 README](README.md): 项目核心文档与快速上手指南
- [贡献指南](CONTRIBUTING.md): 项目参与与代码贡献规范
- [行为准则](CODE_OF_CONDUCT.md): 社区行为规范与约束

## Specifications

- [技术规范](spec/technical-spec.md): 详细的技术需求与架构约束
- [API 规范](spec/api-spec.md): 接口定义与数据契约

## Examples

- [基础示例](examples/basic-usage.md): 基础用法演示
- [进阶示例](examples/advanced-usage.md): 复杂场景实现模式

## Configuration

- [环境搭建指南](docs/setup.md): 项目安装与配置说明
- [部署指南](docs/deployment.md): 生产环境部署说明

## Optional

- [架构文档](docs/architecture.md): 系统整体架构详解
- [设计决策记录](docs/decisions.md): 历史技术选型与设计决策 ADR

验收标准

生成的 llms.txt 文件应当达到以下标准：

  1. 让 LLM 能够迅速理解代码库的核心定位
  2. 为核心文档提供清晰的导航入口
  3. 严格遵循官方 llms.txt 规范
  4. 内容全面且精炼干净
  5. 同时满足人类开发者与 LLM 的高效阅读需求
  6. 完整涵盖理解项目所需的所有关键文件
  7. 全文语言通俗严谨、准确无歧义
  8. 结构层次分明，易于读取和解析