AI Skills
update-llms

update-llms

热门

根据 https://llmstxt.org/ 的 llms.txt 规范，更新根目录下的 llms.txt 文件，使其准确反映文档或技术规范的最新变更。

3.7万Star
4569Fork
更新于 2026/7/14
获取 Skill源代码

相关 Skills

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

根据 https://llmstxt.org/ 的 llms.txt 规范，更新根目录下的 llms.txt 文件，使其准确反映文档或技术规范的最新变更。

更新 LLMs.txt 文件

更新项目根目录中现有的 llms.txt 文件，使其准确反映最新的文档、规范或仓库结构变更。该文件旨在为大语言模型（LLM）提供高阶导航指引，帮助其快速定位并理解仓库的核心功能与技术规范。

核心指令

在严格遵循 llms.txt 规范的前提下，更新现有的 llms.txt 文件，使其与当前的仓库结构和内容保持同步。文件既要便于 LLM 解析读取，也要保持良好的人类可读性。

分析与规划阶段

在更新 llms.txt 文件之前，必须完成全面深入的分析：

第一步：审查现有文件与规范

  • 读取现有的 llms.txt 文件，掌握当前的内容结构
  • 查阅 https://llmstxt.org/ 上的官方规范，确保持续符合标准
  • 根据仓库的最新变化，梳理出需要更新的区域

第二步：分析仓库结构

  • 使用合适工具排查当前的仓库文件结构
  • 对比当前结构与现有 llms.txt 中的记录
  • 找出需要新增包含的目录、文件或文档
  • 标记已被删除或移动、需要同步更新的文件

第三步：内容检索与变更检测

  • 识别新增的 README 文件及其位置
  • 查找新增的文档文件（如 /docs/、/spec/ 等目录下的 .md 文件）
  • 定位新增的技术规范文件及其用途
  • 寻找新增的配置文件及其关联性
  • 查找新增的示例文件和代码片段
  • 梳理现有文档结构的任何调整

第四步：制定更新计划

基于分析结果，制定一份条理分明的计划，包含：

  • 维持准确性所需的修改项
  • 需要补充到 llms.txt 中的新文件
  • 需要清理或更新的失效引用
  • 提升整体清晰度的组织结构优化项

实现要求

格式规范

更新后的 llms.txt 文件必须严格遵循规范定义的结构：

  1. H1 标题：单行，包含仓库/项目名称（必填）
  2. 引用块摘要：引用块格式的简短描述（可选，推荐）
  3. 补充细节：零个或多个无需标题的 Markdown 段落，用于补充上下文
  4. 文件列表章节：零个或多个 H2 章节，包含链接组成的 Markdown 列表

内容要求

必须具备的要素
  • 项目名称：作为 H1 标题，需清晰且具描述性
  • 摘要：简明扼要的引用块，说明仓库的核心用途
  • 关键文件：按分类整理的核心文件（H2 章节）
文件链接格式

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

章节划分

将文件合理归类到不同的 H2 章节中，例如：

  • Documentation：核心文档文件
  • Specifications：技术规范与需求说明
  • Examples：示例代码与用法范例
  • Configuration：安装与配置文件
  • Optional：次要文件（特殊语义：在上下文长度受限时可跳过）

内容编写指南

语言与风格
  • 使用精炼、清晰、无歧义的表述
  • 避免使用未加说明的生僻术语
  • 兼顾人类读者与 LLM 的阅读体验
  • 描述信息要具体且富有实效
文件选取标准

应当收录的文件：

  • 阐明仓库用途与范围的文件
  • 提供关键技术文档的文件
  • 展示使用示例和模式的文件
  • 定义接口与规范的文件
  • 包含配置与安装指南的文件

应当排除的文件：

  • 纯粹的底层实现细节
  • 包含冗余信息的文件
  • 构建产物或自动生成的内容
  • 对理解项目没有直接帮助的文件

执行步骤

第一步：当前状态分析

  1. 深入研读现有的 llms.txt 文件
  2. 完整排查当前的仓库文件结构
  3. 对比现有的文件引用与真实的仓库内容
  4. 查找过期、遗漏或错误的引用项
  5. 记录现有文件结构中存在的任何问题

第二步：内容规划

  1. 确定核心用途描述是否需要更新
  2. 审阅并在必要时更新摘要引用块
  3. 规划新增文件和目录的录入
  4. 规划清理过时或已移动的内容
  5. 梳理章节划分，提高层次清晰度

第三步：文件更新

  1. 更新仓库根目录下的 llms.txt 文件
  2. 确保完全符合格式规范要求
  3. 添加新的文件引用并附上恰当的描述
  4. 删除或更新陈旧的引用
  5. 确保所有链接均为有效的相对路径

第四步：校验确认

  1. 确认内容完全符合 https://llmstxt.org/ 规范
  2. 检查所有链接是否有效且可正常访问
  3. 确保该文件依然能作为 LLM 的高效导航工具
  4. 确认文件对人类和机器均具备良好的可读性

质量保证

格式校验

  • ✅ 包含项目名称的 H1 标题
  • ✅ 引用块摘要（若提供）
  • ✅ 用于展示文件列表的 H2 章节
  • ✅ 标准的 Markdown 链接格式
  • ✅ 无失效或无效链接
  • ✅ 全文排版格式保持一致

内容校验

  • ✅ 用词清晰无歧义
  • ✅ 完整覆盖核心关键文件
  • ✅ 内容组织条理清晰
  • ✅ 文件描述精准恰当
  • ✅ 能够高效引导 LLM 进行导航

规范符合度

  • ✅ 完全遵循 https://llmstxt.org/ 格式标准
  • ✅ 使用要求的 Markdown 结构
  • ✅ 恰当合理地使用可选章节
  • ✅ 文件存放在仓库根目录（/llms.txt）

更新策略

新增流程

添加新内容时：

  1. 为新文件选择最贴切的章节
  2. 创建清晰且具备描述力的链接名称
  3. 撰写简明扼要又信息丰富的文件说明
  4. 章节内保持拼音/字母或逻辑上的排列顺序
  5. 评估是否需要为全新的内容类型开辟新章节

移除流程

清理失效内容时：

  1. 确认相关文件确实已被删除或移位
  2. 检查被移动的文件是否应当更新路径而非直接删除
  3. 若某章节变为空白，直接移除该章节
  4. 必要时同步更新交叉引用

结构重构流程

重构内容组织时：

  1. 保持从宏观到微观的逻辑递进
  2. 将核心文档保留在主要章节
  3. 适当时可将次要内容移至“Optional”章节
  4. 确保新结构有助于提升 LLM 的导航效率

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. 准确反映当前的仓库结构与最新内容
  2. 保持与 llms.txt 规范的全面兼容
  3. 为核心文档提供清晰直观的导航指引
  4. 彻底清理陈旧或错误的引用
  5. 及时收录重要的新增文件与文档
  6. 维持合理的组织结构，便于 LLM 读取与消化
  7. 全文采用清晰、准确、无歧义的表述
  8. 持续为人类与机器读者提供优质的阅读体验