> For the complete documentation index, see [llms.txt](https://livlog-llc.gitbook.io/engineering-handbook/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://livlog-llc.gitbook.io/engineering-handbook/riburoguno/8-knowledge-search.md).

# 8. 知識の探し方

リブログでは、複数のプロダクト、データ、記事、API、GitHubリポジトリが存在します。

必要な情報を探せる状態にしておくことは、開発効率と保守性に直結します。

## 探す順番

情報を探すときは、次の順番を基本にします。

1. README
2. docsディレクトリ
3. Issue
4. コード
5. データファイル
6. 公開サイト
7. Handbook
8. 過去のAIプロンプト

## READMEで探すこと

READMEでは、プロジェクトの概要、実行方法、環境変数、デプロイ方法を確認します。

READMEに書かれていない詳細は、docsディレクトリを確認します。

## docsで探すこと

docsには、仕様、設計、運用手順、判断理由を残します。

特に、コードからは分かりにくい情報を優先して記載します。

* なぜその仕様にしたのか
* どのデータを使っているのか
* どのように加工しているのか
* どの外部APIに依存しているのか
* どの制約があるのか

## Issueで探すこと

Issueでは、過去の作業内容や判断経緯を確認します。

実装結果だけでなく、迷ったこと、保留したこと、次にやることも残しておくと、後から役に立ちます。

## AIに聞く前に確認すること

AIに質問する前に、次の情報を渡せる状態にします。

* 対象プロダクト
* 目的
* 関連ファイル
* 期待する動作
* 現在の問題
* 参考にすべき仕様

AIは文脈が不足すると推測で補いやすいため、必要な情報をできるだけ明示します。
