Moxie Docs

Moxie Docsとは？

Moxie Docsは、GitHubリポジトリ向けのドキュメントシステムで、コードベースのドキュメントを自動生成・維持します。リポジトリを索引化し、アーキテクチャ、規約、手順の検索可能なドキュメントを作成し、コード変更時にそれらのページを再確認することで、古い内容を検知して書き直せるようにします。

また、MCP経由でリポジトリの規約と検証済みコンテキストをAIツールに公開し、タスク単位で絞られた読み取り専用アクセスを提供します。さらに、週次のdocs-only「Friday Cleanup」プルリクエストを開き、週の間に蓄積したドリフトをまとめて整理できます。

主な機能

• 継続的なリポジトリ索引化: MoxieはGitHubリポジトリに接続し、マージが進むにつれて索引を最新に保つため、ドキュメントを最新コードに紐づけられます。
• ソース引用付きの生成ドキュメント: アーキテクチャページ、規約、手順をソースコードへの引用付きで作成し、出力を検証しやすくします。
• マージ時のドリフト検知: コード変更が既存ドキュメントに影響すると、Moxieがドリフトを検知して、古いまま残さず関連ページを再生成します。
• エージェント向けMCPコンテキスト: Cursor、Claude Code、CodexなどのAIツールは、プロンプトごとにリポジトリを再クロールせずに、MCP経由で規約、ドキュメント、検証済みコマンドを取得できます。
• Friday Cleanup PR: 週1回、Moxieはdocs-onlyのプルリクエストを開き、レビュー用にドキュメント更新をまとめて提示できます。
• PRワークフロー確認: マージ前に、プルリクエストのドキュメントへの影響と説明の整合性を確認でき、コード変更とマージの制御はチーム側に残します。

Moxie Docsの使い方

まずGitHubリポジトリを接続します。Moxieがコードベースを索引化し、最初のドキュメント群を生成し、人やAIエージェントが再利用できる規約を要約します。

その後は主に2つの使い方があります。Moxieが生成・更新するドキュメントをレビューすること、そして新しいプルリクエストに対して古いドキュメントや説明の不一致がないか確認させることです。必要に応じて、MCP統合を使い、コーディングエージェントがリポジトリ固有のコンテキストを範囲限定の読み取り専用で取得できます。

ユースケース

• アーキテクチャドキュメントを最新に保つ: チームはWebhookの動作や請求フローなどのページを維持し、関連コードの変更が入るとMoxieがドキュメントを更新します。
• コーディングエージェントにリポジトリコンテキストを与える: Cursor、Claude Code、Codexを使う開発者は、リポジトリを手動で閲覧せずに規約や検証済みコマンドを取得できます。
• 週次でドキュメントのドリフトを確認する: 定期的な整理サイクルを望むチームは、場当たり的に古いページを追いかける代わりに、docs-onlyのFriday Cleanup PRをレビューできます。
• マージ前にPRの影響を確認する: 保守担当者は、プルリクエストがドキュメントに影響するか、または説明文の書き換えが必要かをマージ前に把握できます。
• 新しいエンジニアのオンボーディング: 新規参加者は、複数のソースファイルを読む代わりに、生成されたドキュメントとブックマークを1つのワークスペースで検索して規約を理解できます。

FAQ

Moxieはコードを自動で変更しますか？ いいえ。ソースによると、コード変更はチームの管理下にあります。ドキュメント更新はレビュー可能なdocs-onlyのプルリクエストとして提供され、説明の整合性調整はコードではなくPR説明を編集します。

リポジトリを接続すると何が起こりますか？ Moxieはリポジトリを索引化し、検索可能なドキュメントを生成し、規約を要約し、新しいプルリクエストについてドキュメントへの影響と説明の整合性を確認し始めます。

リポジトリへのアクセスは範囲限定ですか？ はい。製品説明では、アクセスはデフォルトで読み取り専用、かつリポジトリごとに範囲限定とされており、MCPコンテキストもコードベース全体ではなくタスクに限定されます。

どのような種類のドキュメントを生成しますか？ このページでは、アーキテクチャページ、規約、手順、そして請求Webhookのようなトピックのドキュメントが具体的に挙げられています。

GitHubでのみ動作しますか？ このページはGitHubリポジトリ向けに書かれているため、ここで説明されている対応ソースはGitHubです。

代替手段

• Markdownでの手動ドキュメント作成、またはdocs wiki: これが最もシンプルな代替手段ですが、コードとの照合を自動で再実行したり、ソース引用付きの更新を生成したりはしません。
• 汎用的なコード検索・リポジトリ閲覧ツール: ファイルの確認には役立ちますが、維持されたドキュメント層やdocs-onlyのクリーンアップPRは提供しません。
• repo-awareなdocsを持たない単体のAIコーディングアシスタント: 質問に答えたりコードを編集したりできますが、Moxieのような仕組みと組み合わせない限り、モデルがコンテキストを再発見する必要があります。
• プルリクエストとレビューを中心にした社内ドキュメント運用: チームはPRを通じて手動でドキュメントを管理できますが、コードベースから自動生成されるのではなく、ドリフトチェックを自分たちで作成・追跡する必要があります。