update-llms

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 ヘッダー: リポジトリ/プロジェクト名を含む 1 行（必須）
2. ブロッククォートの概要: ブロッククォート形式の簡単な説明（任意ですが推奨）
3. 追加の詳細: 見出しのない 0 個以上の Markdown セクション（コンテキスト用）
4. ファイルリストセクション: リンクの Markdown リストを含む 0 個以上の H2 セクション

コンテンツ要件

必須要素

• プロジェクト名: H1 としての明確で説明的なタイトル
• 概要: リポジトリの目的を説明する簡潔なブロッククォート
• 主要ファイル: カテゴリ別に整理された必須ファイル（H2 セクション）

ファイルリンクの形式

各ファイルリンクは次の形式に従う必要があります: [descriptive-name](relative-url): optional description

セクションの構成

ファイルを論理的な H2 セクションに整理します。例:

• Documentation: 主要なドキュメントファイル
• Specifications: 技術仕様と要件
• Examples: サンプルコードと使用例
• Configuration: セットアップと設定ファイル
• Optional: 補助的なファイル（特別な意味 - より短いコンテキストのためにスキップ可能）

コンテンツのガイドライン

言語とスタイル

• 簡潔で明確、曖昧さのない言語を使用する
• 説明なしの専門用語を避ける
• 人間と LLM の両方の読者に向けて書く
• 説明は具体的かつ有益にする

ファイル選択の基準

以下のファイルを含めます。

• リポジトリの目的と範囲を説明するもの
• 必須の技術ドキュメントを提供するもの
• 使用例とパターンを示すもの
• インターフェースと仕様を定義するもの
• 設定とセットアップの手順を含むもの

以下のファイルは除外します。

• 純粋に実装の詳細であるもの
• 冗長な情報を含むもの
• ビルド成果物や生成されたコンテンツであるもの
• プロジェクトの理解に関連しないもの

実行手順

ステップ 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. 必要に応じて相互参照を更新する

再編成のプロセス

コンテンツを再構築する場合:

1. 一般から具体への論理的な流れを維持する
2. 必須のドキュメントを主要なセクションに保つ
3. 適切な場合は二次的なコンテンツを「オプション」セクションに移動する
4. 新しい構成が LLM のナビゲーションを改善することを確認する

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. 現在のリポジトリ構造とコンテンツを正確に反映している
2. llms.txt 仕様への準拠を維持している
3. 必須のドキュメントへの明確なナビゲーションを提供する
4. 古くなった参照や誤った参照を削除している
5. 新しい重要なファイルとドキュメントを含んでいる
6. LLM が容易に利用できるよう論理的な構成を維持している
7. 全体を通じて明確で曖昧さのない表現を使用している
8. 人間と機械の両方の読者に対して引き続き効果的に機能する