リポジトリ構造から LLMs.txt ファイルを作成

https://llmstxt.org/ の公式 llms.txt 仕様に従い、リポジトリのルートに新しい llms.txt ファイルを一から作成します。このファイルは大規模言語モデル (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 ファイルは仕様に従い、以下の正確な構造に従う必要があります:

1. H1 ヘッダー: リポジトリ/プロジェクト名を含む単一行 (必須)
2. ブロッククォート概要: ブロッククォート形式での簡潔な説明 (オプション、推奨)
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. ファイルが人間と機械の両方で読める形式であることを確認

品質保証

フォーマット検証

• ✅ プロジェクト名の H1 ヘッダー
• ✅ ブロッククォート概要 (含まれている場合)
• ✅ ファイルリスト用の H2 セクション
• ✅ 適切な Markdown リンク形式
• ✅ 壊れたリンク、無効なリンクがない
• ✅ 全体を通じた一貫性のあるフォーマット

コンテンツ検証

• ✅ 明確で曖昧でない表現
• ✅ 必須ファイルの包括的なカバレッジ
• ✅ 論理的なコンテンツ構成
• ✅ 適切なファイル説明
• ✅ 効果的な LLM ナビゲーションツールとして機能

仕様準拠

• ✅ https://llmstxt.org/ フォーマットに正確に従う
• ✅ 必須 Markdown 構造を使用
• ✅ オプションセクションを適切に実装
• ✅ ファイルがリポジトリルートに配置 (/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. LLM がリポジトリの目的を迅速に理解できるようにする
2. 必須ドキュメントへの明確なナビゲーション を提供
3. 公式 llms.txt 仕様に正確に従う
4. 包括的でかつ簡潔である
5. 人間と機械の両方の読者に効果的に対応
6. プロジェクト理解のための すべての重要なファイルを含める
7. 全体を通して明確で曖昧でない表現を使用
8. 簡単に利用できるように論理的にコンテンツを整理