llms-txt-generator

LLM ドキュメントジェネレーター

llms.txt 標準に準拠した、ドメインごとに整理された細分化ファイルを含む、構造化された AI が読み取りやすいドキュメントを生成します。

出力構造

llm-docs/
├── llm.txt                    # Main index (~1-2 KB)
├── llm.version.txt            # Metadata and sync info (~0.3 KB)
└── llm.{domain}.txt           # Domain-specific files (~3-50 KB each)

ワークフロー

フェーズ 1：言語の選択

ドキュメントの出力言語として希望する言語（英語、スペイン語、またはバイリンガル）をユーザーに尋ねます。

フェーズ 2：プロジェクトの分析

プロジェクトの種類とデータソースを特定します。

指標	プロジェクトの種類
components/、デザイントークン、SCSS	フロントエンド／UI ライブラリ
cmd/、CLI フラグ、サブコマンド	CLI ツール
/api/、OpenAPI、ルート	REST／GraphQL API
src/、エクスポート、package.json	汎用ライブラリ

構造化データソースを検出します。

• JSON メタデータファイル（コンポーネントのドキュメント、OpenAPI 仕様）
• JSDoc／GoDoc コメント
• TypeScript 定義
• 設定ファイル（package.json、go.mod）
• 既存のドキュメント（README、docs/）

フェーズ 3：ドメインの計画

プロジェクトの種類に基づいて、作成する llm.{domain}.txt ファイルを計画します。

• フロントエンド／UI：references/frontend-example.md を参照してください
• CLI ツール：references/cli-example.md を参照してください
• API：references/api-example.md を参照してください
• ライブラリ：references/library-example.md を参照してください

フェーズ 4：実装方法の決定

条件	方法
構造化データがある（JSON、JSDoc、OpenAPI）	ジェネレータースクリプトを作成する
手動でドキュメントを作成する必要がある	静的な Markdown ファイルを作成する
ソースが混在している	ハイブリッド：構造化データにはスクリプトを使用し、それ以外は手動で作成する

ジェネレータースクリプトの構造については、references/generator-script-pattern.md を参照してください。

フェーズ 5：ファイルの生成

llm.version.txt（常に最初に作成）

# {Project} LLM Documentation

- **Version**: {semantic version}
- **Last Updated**: {YYYY-MM-DD}
- **Documentation Version**: 1.0.0
- **Files**: {count} domain files
- **Total Size**: ~{X} KB

llm.txt（メインインデックス）

# {Project} - LLM Documentation

## Project Metadata
- **Name**: {project name}
- **Type**: {frontend|cli|api|library}
- **Language**: {primary language}
- **Purpose**: {one-line description}

## Quick Reference
- **Key Modules**: {list main areas}
- **Patterns**: {architectural patterns used}
- **Dependencies**: {key dependencies}

## Documentation Structure

### {Domain 1}
#### llm.{domain1}.txt
- **Focus**: {what this file covers}
- **Use when**: {scenarios to read this file}

## Reading Guide

1. Start with `llm.version.txt` for metadata
2. Read `llm.{primary-domain}.txt` for core concepts
3. Reference other files as needed

llm.{domain}.txt（ドメインファイル）

各ドメインファイルは次の構造に従います。

# {Domain} - {Project}

## Overview
{2-3 sentences explaining this domain}

## {Section 1}

| Name | Type | Description |
|------|------|-------------|
| ... | ... | ... |

## Related Files
- `llm.{related}.txt` - {why related}

ベストプラクティス

1. ファイルサイズ：LLM のコンテキストを最適に活用できるよう、各ファイルを 50 KB 未満に保ちます
2. 相互参照：ファイル間をリンクし、いつ読むべきかを明確に示します
3. 表：プロパティ、トークン、パラメーターには Markdown の表を使用します
4. コード例：実用的で、そのままコピーして使える例を含めます
5. 階層：見出しレベルを統一します（タイトルには H1、セクションには H2、サブセクションには H3）

完成例については、references/complete-output-example.md を参照してください。