AI Skills
update-llms

update-llms

熱門

遵循 https://llmstxt.org/ 的 llms.txt 規範，更新根目錄下的 llms.txt 檔案，以準確反映說明文件或規格書的變更。

3.7萬星標
4569分支
更新於 2026/7/14
獲取技能源代碼

相關技能

academy-guide17萬pr8.2萬systematic-literature-review8萬
SKILL.md
唯讀
名稱
update-llms
描述

遵循 https://llmstxt.org/ 的 llms.txt 規範，更新根目錄下的 llms.txt 檔案，以準確反映說明文件或規格書的變更。

更新 LLMs.txt 檔案

更新專案儲存庫根目錄現有的 llms.txt 檔案，以反映說明文件、規格書或儲存庫結構的最新變更。此檔案為大型語言模型（LLM）提供高階導覽指引，幫助模型快速找到理解本專案目的與規格所需的相關內容。

核心指令

更新現有的 llms.txt 檔案，在反映當前儲存庫結構與內容的同時，保持內容準確度並符合 llms.txt 規範。該檔案必須持續針對 LLM 的讀取進行最佳化，同時保持良好的可讀性。

分析與規劃階段

在更新 llms.txt 檔案之前，必須完成全面的分析：

步驟 1：審視現有檔案與規範

  • 閱讀現有的 llms.txt 檔案以瞭解當前結構
  • 檢閱 https://llmstxt.org/ 上的官方規範，確保持續符合標準
  • 根據儲存庫的變更，找出可能需要更新的區域

步驟 2：儲存庫結構分析

  • 使用合適的工具檢查當前儲存庫結構
  • 將當前結構與現有 llms.txt 中記錄的內容進行比對
  • 找出應納入的新目錄、檔案或說明文件
  • 記錄任何已刪除或搬移而需要更新的檔案

步驟 3：內容探索與變更偵測

  • 找出新的 README 檔案及其位置
  • 尋找新的說明文件檔案（如 /docs/、/spec/ 等目錄下的 .md 檔案）
  • 定位新的規格書檔案及其用途
  • 尋找新的設定檔及其相關性
  • 尋找新的範例檔案與程式碼範例
  • 找出既有說明文件結構的任何變更

步驟 4：建立更新計畫

根據分析結果，建立包含以下內容的結構化計畫：

  • 為保持準確性所需進行的變更
  • 需新增至 llms.txt 的新檔案
  • 需移除或更新的過時引用
  • 為保持清晰度而進行的組織結構改善

實作要求

格式合規性

更新後的 llms.txt 檔案必須嚴格遵循規範中的以下結構：

  1. H1 標題：單行專案/儲存庫名稱（必填）
  2. 區塊引言摘要：使用區塊引言（blockquote）格式的簡短說明（選填，但建議提供）
  3. 補充細節：零個或多個不帶標題的 Markdown 段落，用於提供背景資訊
  4. 檔案清單區段：零個或多個包含 Markdown 連結清單的 H2 區段

內容要求

必備元素
  • 專案名稱：清晰且具描述性的 H1 標題
  • 摘要：簡明扼要的區塊引言，說明儲存庫的目的
  • 關鍵檔案：按類別組織的核心檔案（H2 區段）
檔案連結格式

每個檔案連結必須遵循：[描述性名稱](相對路徑): 選填的說明文字

區段組織

將檔案整理至合理的 H2 區段中，例如：

  • 說明文件（Documentation）：核心說明文件
  • 規格書（Specifications）：技術規格與需求
  • 範例（Examples）：範例程式碼與使用範例
  • 設定（Configuration）：安裝與設定檔
  • 選填（Optional）：次要檔案（具有特殊意義——在上下文長度受限時可跳過）

內容撰寫指南

語言與風格
  • 使用簡潔、清晰、無歧義的語言
  • 避免使用未經解釋的專業術語
  • 同時兼顧人類與 LLM 讀者的閱讀體驗
  • 在描述中保持具體且富含資訊
檔案篩選標準

應包含具備以下特性的檔案：

  • 說明儲存庫的目的與範圍
  • 提供必要的技術說明文件
  • 展示使用範例與設計模式
  • 定義介面與規格
  • 包含設定與安裝說明

應排除具備以下特性的檔案：

  • 純粹屬於實作細節
  • 包含重複或贅餘的資訊
  • 建置產物（build artifacts）或自動生成的內容
  • 與理解專案無關的檔案

執行步驟

步驟 1：當前狀態分析

  1. 深入閱讀現有的 llms.txt 檔案
  2. 完整檢查當前儲存庫結構
  3. 比對現有的檔案引用與實際儲存庫內容
  4. 找出過時、遺漏或錯誤的引用
  5. 記錄當前檔案中的任何結構性問題

步驟 2：內容規劃

  1. 確認主要目的說明是否需要更新
  2. 審視並在必要時更新摘要區塊引言
  3. 規劃新增檔案與目錄的加入方式
  4. 規劃移除過時或已搬移的內容
  5. 必要時重新組織區段以提升清晰度

步驟 3：檔案更新

  1. 更新儲存庫根目錄下的現有 llms.txt 檔案
  2. 嚴格符合格式規範的要求
  3. 加入新的檔案引用並附上適當說明
  4. 移除或更新過時的引用
  5. 確保所有連結皆為有效的相對路徑

步驟 4：驗證

  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. 必要時更新交叉引用（cross-references）

重組流程

重組內容時：

  1. 保持從概括到具體的邏輯脈絡
  2. 將核心說明文件保留在主要區段
  3. 適當時可將次要內容移至「選填（Optional）」區段
  4. 確保新的組織結構有助於提升 LLM 的導覽效率

llms.txt 的範例結構：

# [儲存庫名稱]

> [簡明扼要說明儲存庫的目的與範圍]

[選填的補充背景段落，不帶標題]

## Documentation

- [Main README](README.md): 主要專案說明文件與快速入門指南
- [Contributing Guide](CONTRIBUTING.md): 專案貢獻指南
- [Code of Conduct](CODE_OF_CONDUCT.md): 社群行為準則與規範

## Specifications

- [Technical Specification](spec/technical-spec.md): 詳細的技術需求與限制
- [API Specification](spec/api-spec.md): 介面定義與資料契約

## Examples

- [Basic Example](examples/basic-usage.md): 基礎使用示範
- [Advanced Example](examples/advanced-usage.md): 複雜實作模式

## Configuration

- [Setup Guide](docs/setup.md): 安裝與設定指南
- [Deployment Guide](docs/deployment.md): 正式環境部署指南

## Optional

- [Architecture Documentation](docs/architecture.md): 詳細的系統架構
- [Design Decisions](docs/decisions.md): 歷史設計決策紀錄

成功標準

更新後的 llms.txt 檔案應達到以下標準：

  1. 準確反映當前儲存庫結構與內容
  2. 持續符合 llms.txt 規範
  3. 為核心說明文件提供清晰的導覽
  4. 移除過時或錯誤的引用
  5. 包含重要的新檔案與說明文件
  6. 保持邏輯組織，方便 LLM 讀取理解
  7. 全文使用清晰、無歧義的語言
  8. 能持續有效地服務人類與機器讀者