create-llms について
プロジェクトのルートに仕様準拠の `llms.txt` を作成するためのリポジトリスキルです。エージェントによる構成の調査、ファイルの選定と整理、作成、リンク検証を案内します。
主な機能
- 01リポジトリ構成とドキュメントの調査
- 02LLM理解に必要なファイルの選定
- 03Markdownセクションでリンクを整理
- 04ルートに `llms.txt` を作成
- 05形式と相対リンクの検証
活用シーン
- 01リポジトリにLLM向け案内を追加
- 02重要な文書や仕様ファイルを特定
- 03`llms.txt` のリンクと構成を確認
インストール
コマンドをコピーしてターミナルで実行します。
$
npx skills add https:/インストール後、Claude Code で/create-llmsを入力して読み込まれたか確認します。
詳細
リポジトリ構造から LLMs.txt ファイルを作成する
https://llmstxt.org/ にある公式の llms.txt 仕様に従って、リポジトリのルートに llms.txt ファイルを新規に作成します。このファイルは、リポジトリの目的と仕様を理解するために、関連するコンテンツがどこにあるかを大規模言語モデル（LLM）に高レベルで案内するものです。
主要な指示
LLM がリポジトリを効果的に理解し、ナビゲートするための入口として機能する、包括的な llms.txt ファイルを作成します。このファイルは 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 ファイルは、仕様に従って次の正確な構造に従う必要があります。
- H1 ヘッダー: リポジトリ／プロジェクト名を含む 1 行（必須）
- ブロッククォートの要約: ブロッククォート形式の簡単な説明（任意ですが推奨）
- 追加の詳細: 見出しのない 0 個以上の Markdown セクション（コンテキスト用）
- ファイルリストのセクション: リンクの Markdown リストを含む 0 個以上の H2 セクション
コンテンツの要件
必須の要素
- プロジェクト名: H1 としての明確で説明的なタイトル
- 要約: リポジトリの目的を説明する簡潔なブロッククォート
- 主要なファイル: カテゴリ別に整理された必須ファイル（H2 セクション）
ファイルリンクの形式
各ファイルリンクは次の形式に従う必要があります: [descriptive-name](relative-url): optional description
セクションの構成
ファイルを次のような論理的な H2 セクションに整理します。
- ドキュメント: 中核となるドキュメントファイル
- 仕様: 技術仕様と要件
- 例: サンプルコードと使用例
- 設定: セットアップと設定ファイル
- Optional: 二次的なファイル（特別な意味 - より短いコンテキストのために省略可能）
コンテンツのガイドライン
言語とスタイル
- 簡潔で明確、曖昧さのない言語を使用する
- 説明なしの専門用語を避ける
- 人間と LLM の両方の読者に向けて書く
- 説明は具体的かつ情報豊富にする
ファイル選択の基準
次のファイルを含めます。
- リポジトリの目的と範囲を説明するもの
- 不可欠な技術ドキュメントを提供するもの
- 使用例とパターンを示すもの
- インターフェースと仕様を定義するもの
- 設定とセットアップの手順を含むもの
次のファイルは除外します。
- 純粋に実装の詳細であるもの
- 冗長な情報を含むもの
- ビルド成果物や生成されたコンテンツであるもの
- プロジェクトの理解に関係しないもの
実行ステップ
ステップ 1: リポジトリの分析
- リポジトリ構造を完全に調査する
- メインの README.md を読んでプロジェクトを理解する
- すべてのドキュメントディレクトリとファイルを特定する
- 仕様ファイルとその目的を一覧化する
- サンプルファイルと設定ファイルを見つける
ステップ 2: コンテンツの計画
- 主な目的の記述を決定する
- ブロッククォート用の簡潔な要約を書く
- 特定したファイルを論理的なカテゴリにグループ化する
- LLM の理解にとっての重要度でファイルを優先順位付けする
- 各ファイルリンクの説明を作成する
ステップ 3: ファイルの作成
- リポジトリのルートに
llms.txtファイルを作成する - 正確なフォーマット仕様に従う
- 必要なすべてのセクションを含める
- 適切な markdown フォーマットを使用する
- すべてのリンクが有効な相対パスであることを確認する
ステップ 4: 検証
- https://llmstxt.org/ の仕様への準拠を確認する
- すべてのリンクが有効でアクセス可能であることを確認する
- ファイルが効果的な LLM ナビゲーションツールとして機能することを確認する
- ファイルが人間とマシンの両方にとって読みやすいことを確認する
品質保証
フォーマットの検証
- ✅ プロジェクト名を含む 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 ファイルは、次の条件を満たす必要があります。
- LLM がリポジトリの目的をすばやく理解できるようにする
- 必須ドキュメントへの明確なナビゲーションを提供する
- 公式の llms.txt 仕様に正確に従っている
- 包括的でありながら簡潔である
- 人間とマシンの両方の読者に効果的に役立つ
- プロジェクトの理解に不可欠なすべてのファイルを含める
- 全体を通じて明確で曖昧さのない言葉遣いを使用する
- 容易に消費できるようコンテンツを論理的に構成する
コメント
Markdown 対応