2026-09-10 -- README・ドキュメントの整理(第三者への公開準備)

発端: ユーザー依頼「Readme の整理・ドキュメントの整理。第三者への公開準備」。 リポジトリをプライベートから公開に切り替える前提で、利用者・貢献者が最初に触れる 文書を整え、作者の環境に固有の記述や誤って追跡されていたファイルを取り除く。

1. 公開前に見つかった問題

問題	場所	対処
「プライベートリポジトリのため…」という前提が 2 か所に残っていた	README.md インストール節・ライセンス節	削除。Git URL 導入を「推奨」と明記
特徴一覧が 25 項目の平坦なリストで、ライトマップの項目だけ 1 段落 500 字超	README.md	5 カテゴリ(チャット体験 / 権限と安全性 / Unity 連携 / UapOps / 設定)に再編し、各項目を 1〜2 文に圧縮。詳細は設計ノートへ誘導
英語の入口がなかった(CHANGELOG と package.json だけ英語)	ルート	README.en.md を追加し、日英を相互リンク
開発者向け情報が README の末尾に埋もれていた	README.md	CONTRIBUTING.md に移し、リポジトリ構成(Editor/Ops・ci/ を追記)・テスト実行・CI の前提(フォークでは EditMode CI が動かない)・規約・PR の作法をまとめた
docs/ に索引がなく、設計ノート 100 本・調査 11 本・検証記録 126 ファイルの位置づけが分からない	docs/	docs/README.md を追加。各フォルダの役割・読み方・「作者環境固有の記述が残っている」注意書き
ルートに LICENSE がなく GitHub がライセンスを検出できない	ルート	パッケージの LICENSE.md と同内容の LICENSE を追加。README からはこちらを指す
9.7 MB の Mono クラッシュダンプが誤って追跡されていた	ci/HostProject/mono_crash.mem.7923.1.blob	追跡解除し、ci/HostProject/.gitignore に mono_crash.* を追加
Claude Code のローカル設定(作者の Unity プロジェクトのパスを含む)が追跡されていた	.claude/settings.local.json	追跡解除して .gitignore に追加。プロジェクト共通で有用な許可リストだけ .claude/settings.json に移した(個人パスを含む 1 行は削除)
別プロジェクト(UITK Font Kit)の新規開発用キックオフプロンプトが混入していた	docs/kickoff-uitk-font-kit.md	削除。内容は作者の別リポジトリの起点であり、本パッケージの文書ではない。作者のローカルパスとプライベートリポジトリの情報も含んでいた
パッケージ側 README / Documentation~/index.md が古い(npm でのインストール手順、Editor/Ops 未記載、相対リンクが Package Manager 表示では壊れる)	パッケージ	現状に合わせて書き直し、リポジトリの絶対 URL でリンク
リリース手順の「サンドボックス(AITemp)」が作者固有	docs/RELEASING.md	「検証用サンドボックスプロジェクト(CONTRIBUTING.md 参照)」に一般化
アーキテクチャ文書のステータスが「承認待ち Draft v1」のまま。検証環境として作者のプロジェクトパスを記載	docs/ARCHITECTURE.md	ステータスを承認済みに更新し、環境記述が歴史的記録である旨の注記を追加。本文は改変しない

1b. 追加依頼(同日): 操作ガイドとインストール URL の表記

• docs/USER-GUIDE.md(操作ガイド)を新設。 README は「何ができるか」の紹介に留め、 「どう操作するか」は 1 本のガイドにまとめた。画面構成・チャット・チップと添付・権限カード・ 自動承認レベル・質問カード・ツール/サブエージェントカード・履歴・モデル・スラッシュコマンド・ UapOps・マーカーとピン・リロード共存・設定リファレンス・ショートカット・トラブル対処の 17 節。 文言は UiStringsJa.cs の実際の UI 文字列に合わせ、機能の有無は該当ソース (ContextBarView のピンボタン、HistoryRowMenuModel のメニュー項目、UapTurnScope の Undo グループ、AssetLinkHub のパスリンク化など)で確認した。README(日英)と docs/README.md からリンク。
• インストール URL を Markdown リンク表記に変更。 ユーザー指定により、表示テキストは タグなしの ...?path=jp.colloid.unity-agent-panel、リンク先はタグ付き(#v0.36.0)とした。 タグはリンクの href とその直後の説明文の 2 か所に残るので、リリース時の更新箇所は従来通り 2 か所(CLAUDE.md の手順を README.en.md も含む形に更新)。

2. 意図的に残したもの

• docs/research/ と設計ノートに残る作者環境のパス(C:/Unity/UnityProjects/...、 サンドボックス名、作者の VRChat アバタープロジェクトの構成調査 research/04)。 実測の記録として価値があり、書き換えると証跡としての意味を失う。docs/README.md に 「作者環境固有の記述で、動作要件ではない」と明記することで対処した。 research/04 は作者の私的プロジェクトの内部構成を記述しているため、公開前に削除するか どうかは作者の判断に委ねる(本タスクでは触っていない)。
• docs/verify/ の XML(約 35 MB)。設計ノート 39 か所から参照される証跡。 削除しても Git 履歴からは消えずクローンサイズは減らないため、そのまま残す。
• テストコード内の AITemp / DevelopmentProject 文字列。テストの入力データや 実測の根拠を示すコメントで、動作には影響しない。
• README のスクリーンショット。v0.28 の UI 再設計以前のものが混じるが、差し替えには 実機が必要なので本タスクの範囲外。

3. リリース判断

パッケージのコード・挙動に変更はない。パッケージ内の README と Documentation~ は Package Manager に表示されるため CHANGELOG の [Unreleased] に ### Changed として 記録するが、CLAUDE.md の規約「docs/CI のみの変更はリリース不要」に従い、本タスクでは バージョンを切らない。次のリリースに同梱される。