ErrorInsight をご利用いただきありがとうございます。

このファイルは、ErrorInsight を使い始める前に最初に読む案内です。

============================================================
1. ErrorInsight とは
============================================================

ErrorInsight は、コピーしたエラーログから「エラーらしい行」を探し、
日本語で簡単な説明、原因候補、確認ポイントを表示するツールです。

長いログの中から、まずどの行を見ればよいかを探しやすくするための
補助ツールです。

対応している主なログ:

- Python
- Java
- C#
- JavaScript
- SQL
- その他、error / exception / traceback / failed / fatal などを含む行

バージョン:

- ErrorInsight 01.00.00

============================================================
2. 安全性について
============================================================

ErrorInsight は、ローカル環境で動作します。

起動時にも、以下の内容を表示します。

ErrorInsight
動作モード: ローカル実行
外部通信: なし

ErrorInsight では、以下を行いません。

- 外部APIへの送信
- インターネット通信
- クリップボード内容の保存
- ログの履歴保存
- ファイル保存
- 課金処理
- ライセンス認証

ErrorInsight は、クリップボードにコピーされているテキストを読み取り、
その場で結果を表示するだけのツールです。

============================================================
3. 使う前の準備
============================================================

1. ZIPファイルをダウンロードします。
2. ZIPファイルを任意の場所に展開します。
3. 展開したフォルダの中にある Start_ErrorInsight.bat を確認します。

この配布版は Windows 向けです。

macOS 向け配布は、現時点では未対応です。
将来対応を検討しています。

Python が必要かどうか:

- この配布パッケージには、実行に必要なPython環境を同梱しています。
- 利用者が別途Pythonをインストールする必要はありません。
- Pythonをすでにインストールしている場合でも、通常は追加設定なしで利用できます。

同梱しているPython環境は、ErrorInsightを動かすために使用します。
他のPython環境を変更するものではありません。

配布ページ:

- 公式情報ページ: https://github.com/wakamiki/ErrorInsight
- GitHub Releases: https://github.com/wakamiki/ErrorInsight/releases
- Vector: 公開後、公式情報ページで案内します。

============================================================
4. 基本の使い方
============================================================

1. Start_ErrorInsight.bat をダブルクリックします。
2. ターミナル、コンソール、開発ツールなどに表示されたエラーログをコピーします。
3. 起動した画面で Enter を押します。
4. 結果を確認します。

もう一度使う場合:

1. 起動した画面は閉じずに、そのままにします。
2. 新しいエラーログをコピーします。
3. Enter を押します。
4. 結果を確認します。

終了する場合:

- コンソール画面を閉じます。
- または、q を入力して Enter を押します。

補足:

- 一度起動すると、画面を閉じるまで何度でも続けて使えます。
- PCを終了した後、PCを再起動した後、コンソールを閉じた後、または q + Enter で ErrorInsight を終了した後に使う場合は、もう一度 Start_ErrorInsight.bat を起動してください。

注意:

Start_ErrorInsight.bat を起動したあとに、解析したいエラーログをコピーしてください。
別の文章をコピーしている場合、その文章が読み取られることがあります。

============================================================
5. 表示結果の見方
============================================================

表示例:

2行目       : AttributeError: 'NoneType' object has no attribute 'split'
言語        : Python
説明        : 存在しない機能や値を使おうとした可能性があります。
原因候補    : メソッド名や属性名の間違い、None参照、型違いの可能性があります。
確認ポイント: 対象オブジェクトの型、属性名・メソッド名、Noneになっていないかを確認してください。
ヒント      : 対象の型は 'NoneType'、存在しない属性またはメソッド名は 'split' です。

各項目の意味:

行目:
  コピーしたログ全体の中で、何行目にあったエラーかを示します。

言語:
  ログ全体から推定した言語です。
  Python / Java / C# / JavaScript / SQL / 不明 のいずれかが表示されます。

説明:
  エラーの種類についての簡単な説明です。

原因候補:
  よくある原因の候補です。
  原因を断定するものではありません。

確認ポイント:
  まず確認するとよい場所や観点です。

ヒント:
  エラー本文から読み取れた型名、属性名、変数名、ファイル名などを表示します。
  ヒントがない場合、この行は表示されません。

不明:
  ErrorInsight がエラー種別や言語を十分に判断できなかった場合に表示されます。
  故障ではありません。
  エラー行の前後や、直前に変更したコードを確認してください。

============================================================
6. サンプルログで試す
============================================================

sample_logs フォルダには、動作確認用のサンプルログがあります。

同梱サンプル:

- サンプルログ_Python.txt
- サンプルログ_Java.txt
- サンプルログ_CSharp.txt
- サンプルログ_JavaScript.txt
- サンプルログ_SQL.txt
- サンプルログ_エラーなし.txt

使い方:

1. sample_logs フォルダを開きます。
2. 試したいサンプルログを開きます。
3. Start_ErrorInsight.bat を実行します。
4. サンプルログの中身をすべてコピーします。
5. 起動した画面で Enter を押します。
6. 結果を確認します。

============================================================
7. よくある困りごと
============================================================

Q. クリップボードにログが見つかりませんでした、と表示されます。

A. Start_ErrorInsight.bat を起動したあと、エラーログをコピーしてください。
   空文字や空白だけがコピーされている可能性があります。

Q. エラーらしい行は見つかりませんでした、と表示されます。

A. コピーした文章の中に、ErrorInsight が検出対象にしている
   error / exception / traceback / failed / fatal などの文字が
   含まれていない可能性があります。

Q. 不明と表示されます。

A. ErrorInsight が十分な根拠を持って判断できなかった状態です。
   故障ではありません。
   エラー行の前後や、直前に変更したコードを確認してください。

Q. 画面がすぐ閉じます。

A. 通常は、結果表示後も画面は開いたままです。
   終了する場合は、コンソール画面を閉じるか、q を入力して Enter を押してください。
   もし意図せず閉じてしまう場合は、配布元の案内を確認してください。

Q. PCを閉じた後もそのまま使えますか。

A. PCを終了した後、再起動した後、またはコンソールを閉じた後は、もう一度 Start_ErrorInsight.bat を起動してください。
   起動中の画面が残っている間は、ログをコピーして Enter を押すことで続けて使えます。

Q. セキュリティソフトの警告が出ます。

A. 初回起動時に、Windowsやセキュリティソフトの確認画面が表示される場合があります。
   GitHub Releases または Vector から入手したものか確認してから起動してください。
   ソースコードはGitHubで確認できます。

Q. 文字化けします。

A. Windowsの文字コード設定やターミナル環境の影響を受けている可能性があります。
   次の手順で起動すると改善する場合があります。

   1. ErrorInsight のフォルダを開きます。
   2. フォルダ内の何もない場所で右クリックします。
   3. 「ターミナルで開く」または「PowerShellで開く」を選びます。
   4. 表示された画面で Start_ErrorInsight.bat と入力して Enter を押します。

Q. コピーしたログではなく、別の文字が読み取られます。

A. Start_ErrorInsight.bat を起動したあと、別の文字列をコピーした可能性があります。
   解析したいエラーログをコピーし直してから、もう一度 Enter を押してください。

============================================================
8. 注意事項
============================================================

ErrorInsight は、エラー原因を断定するツールではありません。

表示される内容は、エラー行から見て取れる範囲の参考情報です。
最終的な判断は、ソースコード、公式ドキュメント、実行環境を確認しながら行ってください。

ErrorInsight では、以下のことは行いません。

- ソースコード全体の解析
- 実行環境を踏まえた診断
- 修正コードの自動生成
- 外部AI APIによる分析
- エラーの自動修復

============================================================
9. 削除方法
============================================================

ErrorInsight は、インストーラーを使わないZIP配布です。

削除する場合は、展開した ErrorInsight フォルダごと削除してください。

ErrorInsight は、ログ履歴や設定ファイルを保存しません。

============================================================
10. 公式配布元
============================================================

公式配布元:

- 公式情報ページ: https://github.com/wakamiki/ErrorInsight
- GitHub Releases: https://github.com/wakamiki/ErrorInsight/releases
- Vector: 公開後、公式情報ページで案内します。

開発者連絡先:

- URL：https://wakamiki.github.io/PortfolioMySite/
- 問い合わせメールアドレス： miki.job2026@gmail.com

非公式の配布物や、作者名・内容が異なる配布物にはご注意ください。

============================================================
11. ライセンス
============================================================

ライセンス情報は licenses フォルダにあります。

主なファイル:

- ErrorInsight_LICENSE.txt
- NOTICE.txt
- THIRD_PARTY_NOTICES.txt
- PYPERCLIP_LICENSE.txt
- WCWIDTH_LICENSE.txt
- PYTHON_LICENSE.txt

ErrorInsight 本体は BSD 3-Clause License で公開しています。

再配布や改変版の公開時は、ライセンス表記を残してください。
また、作者の明示的な許可なく、公式版・公認版・共同開発版であるかのように表示しないでください。

第三者ライブラリ:

- pyperclip
- wcwidth

============================================================
12. 詳しい操作説明
============================================================

スクリーンショット付きの詳しい説明は、
操作説明書.pdf を確認してください。

ファイル:

ErrorInsight 操作説明書.pdf


============================================================
以上
============================================================
