AI Skills
create-llms

create-llms

熱門

依據 https://llmstxt.org/ 的 llms.txt 官方規範，根據專案儲存庫結構從頭建立 llms.txt 檔案。

3.6萬星標
4556分支
更新於 2026/7/13
獲取技能源代碼

相關技能

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

依據 https://llmstxt.org/ 的 llms.txt 官方規範，根據專案儲存庫結構從頭建立 llms.txt 檔案。

根據儲存庫結構建立 LLMs.txt 檔案

依據 https://llmstxt.org/ 的官方 llms.txt 規範，在專案儲存庫根目錄從頭建立全新的 llms.txt 檔案。此檔案能為大型語言模型（LLM）提供高階指引，協助其快速定位關鍵內容，以理解儲存庫的宗旨與技術規格。

核心指令

建立一份完整且符合 llms.txt 規範的 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. 檔案清單分區：零個或多個 H2 標題分區，包含 Markdown 連結清單

內容要求

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

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

分區組織方式

將檔案歸類至邏輯清晰的 H2 分區，例如：

  • Documentation：核心說明文件
  • Specifications：技術規格與需求文件
  • Examples：範例程式碼與使用範例
  • Configuration：安裝與設定檔
  • Optional：次要檔案（具有特殊含意——可省略以縮減上下文長度）

內容撰寫指引

語言與風格
  • 使用精煉、清晰、明確的文字
  • 避免使用未經解釋的術語或行話
  • 兼顧人類與 LLM 的閱讀體驗
  • 描述需具體且富含資訊
檔案選用標準

應包含以下檔案：

  • 說明儲存庫目標與範圍的檔案
  • 提供核心技術文件的檔案
  • 展示使用範例與設計模式的檔案
  • 定位介面與規格的檔案
  • 包含設定與安裝指引的檔案

應排除以下檔案：

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

執行步驟

步驟 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. 確認檔案兼具良好的機器可讀性與人類可讀性

品質保證

格式驗證

  • ✅ 包含專案名稱的 H1 標題
  • ✅ 引用區塊摘要（若有包含）
  • ✅ 用於檔案清單的 H2 分區
  • ✅ 正確的 Markdown 連結格式
  • ✅ 無失效或錯誤的連結
  • ✅ 全文格式保持一致

內容驗證

  • ✅ 用字清晰明確、無歧義
  • ✅ 完整涵蓋所有核心關鍵檔案
  • ✅ 內容結構邏輯清晰
  • ✅ 檔案描述適當且精準
  • ✅ 能發揮高效 LLM 導覽工具的作用

規範合規性

  • ✅ 完全符合 https://llmstxt.org/ 的格式要求
  • ✅ 使用指定的 Markdown 結構
  • ✅ 適當運用可選分區
  • ✅ 檔案位於儲存庫根目錄（/llms.txt）

架構範本範例

# [Repository Name]

> [Concise description of the repository's purpose and scope]

[Optional additional context paragraphs without headings]

## Documentation

- [Main README](README.md): Primary project documentation and getting started guide
- [Contributing Guide](CONTRIBUTING.md): Guidelines for contributing to the project
- [Code of Conduct](CODE_OF_CONDUCT.md): Community guidelines and expectations

## Specifications

- [Technical Specification](spec/technical-spec.md): Detailed technical requirements and constraints
- [API Specification](spec/api-spec.md): Interface definitions and data contracts

## Examples

- [Basic Example](examples/basic-usage.md): Simple usage demonstration
- [Advanced Example](examples/advanced-usage.md): Complex implementation patterns

## Configuration

- [Setup Guide](docs/setup.md): Installation and configuration instructions
- [Deployment Guide](docs/deployment.md): Production deployment guidelines

## Optional

- [Architecture Documentation](docs/architecture.md): Detailed system architecture
- [Design Decisions](docs/decisions.md): Historical design decision records

成功標準

建立完成的 llms.txt 檔案應達到以下要求：

  1. 讓 LLM 能快速理解儲存庫的宗旨
  2. 為核心文件提供清晰的導覽入口
  3. 完全遵循 llms.txt 官方規範
  4. 內容面面俱到且精煉不贅述
  5. 能同時有效服務人類與機器讀者
  6. 涵蓋理解專案所需的所有關鍵檔案
  7. 全文使用清晰、明確無歧義的語言
  8. 邏輯清晰地組織內容，方便閱讀與吸收