diff --git a/en/development_tools/ai_tools/index.rst b/en/development_tools/ai_tools/index.rst new file mode 100644 index 000000000..a9514b71a --- /dev/null +++ b/en/development_tools/ai_tools/index.rst @@ -0,0 +1,28 @@ + +============================================ +AI Coding Assistance +============================================ + +.. toctree:: + :maxdepth: 1 + :hidden: + + nabledge/index + +This section introduces AI tools that support Nablarch development. |br| + + +.. list-table:: + :header-rows: 1 + :class: white-space-normal + :widths: 1,2 + + * - Tool Name + - Description + * - :doc:`nabledge/index` + - | A plugin for `Claude Code(External site) `_ / `GitHub Copilot(External site) `_ that provides AI-powered access to Nablarch specifications and best practices. + | Enables question answering and code analysis for development support. + +.. |br| raw:: html + +
diff --git a/en/development_tools/ai_tools/nabledge/_image/nabledge_class_dependency_diagram.png b/en/development_tools/ai_tools/nabledge/_image/nabledge_class_dependency_diagram.png new file mode 100644 index 000000000..689a8ef3c Binary files /dev/null and b/en/development_tools/ai_tools/nabledge/_image/nabledge_class_dependency_diagram.png differ diff --git a/en/development_tools/ai_tools/nabledge/_image/nabledge_knowledge_search_example.png b/en/development_tools/ai_tools/nabledge/_image/nabledge_knowledge_search_example.png new file mode 100644 index 000000000..ef9cc52e9 Binary files /dev/null and b/en/development_tools/ai_tools/nabledge/_image/nabledge_knowledge_search_example.png differ diff --git a/en/development_tools/ai_tools/nabledge/_image/nabledge_sequence_diagram.png b/en/development_tools/ai_tools/nabledge/_image/nabledge_sequence_diagram.png new file mode 100644 index 000000000..6ff103f66 Binary files /dev/null and b/en/development_tools/ai_tools/nabledge/_image/nabledge_sequence_diagram.png differ diff --git a/en/development_tools/ai_tools/nabledge/index.rst b/en/development_tools/ai_tools/nabledge/index.rst new file mode 100644 index 000000000..a5f28a9f7 --- /dev/null +++ b/en/development_tools/ai_tools/nabledge/index.rst @@ -0,0 +1,172 @@ + +========================================================================== +Nablarch-specific AI Coding Tool Plugin +========================================================================== + +.. contents:: Table of Contents + :depth: 2 + :local: + + +Prerequisites +========================================================================== + +This plugin requires `Claude Code(External site) `_ or `GitHub Copilot(External site) `_. + + +What is the Nablarch-specific AI Coding Tool Plugin +========================================================================== + +The Nablarch-specific AI Coding Tool Plugin is an AI assistant equipped with knowledge from the official Nablarch documentation, system development guides, and sample projects. +It operates as a plugin for Claude Code or GitHub Copilot, providing accurate answers to Nablarch-specific specifications and conventions. + +Background +-------------------------------------------- + +In recent years, generative AI has rapidly become part of everyday development, and developers routinely rely on it. +However, Nablarch information is scattered across multiple sources on the web, requiring a broad understanding across sources. +Therefore, generative AI cannot accurately answer Nablarch-specific specifications and conventions. + +Common Challenges in Development +-------------------------------------------- + +Have you experienced these challenges in Nablarch development? + +* "Which documentation contained that configuration?" +* "Looking up API usage requires going back and forth through multiple official documentation pages..." +* "When I ask AI, it suggests non-existent methods, causing more confusion" +* "Explaining Nablarch to team members takes time away from design work" + +How This Plugin Helps +-------------------------------------------- + +By introducing this plugin, you can simply type ``/n5`` in Claude Code or GitHub Copilot Chat and ask questions to get immediate, evidence-based answers about Nablarch specifications and conventions from AI. + + + +Features +============================================ + +Knowledge Search +-------------------------------------------- + +Answers questions based on Nablarch documentation. + +Usage example:: + + /n5 How do I implement a pull-down input for code values? + +Searches related sections across Nablarch documentation and returns answers including code examples and configuration examples. + +**Answer Example** + +.. image:: _image/nabledge_knowledge_search_example.png + :alt: Knowledge search answer example + :scale: 80% + +How it works: + +* Converts official Nablarch documentation to AI-readable JSON format +* Ensures accuracy through two-stage process: keyword full-text search + AI-based relevance determination +* Fallback mechanism where AI selects files from the table of contents when full-text search finds no hits + +Code Analysis +-------------------------------------------- + +Analyzes application code within the project from a Nablarch perspective and documents the overall picture. + +Usage example:: + + /n5 code-analysis + +Visualizes the following information: + +* Class dependencies +* Handler queue configuration +* Processing flow visualized in Mermaid diagrams + +**Output Example** + +Class dependency diagram and component summary: + +.. image:: _image/nabledge_class_dependency_diagram.png + :alt: Class dependency diagram and component summary + :scale: 70% + +Processing flow diagram (sequence diagram): + +.. image:: _image/nabledge_sequence_diagram.png + :alt: Processing flow diagram + :scale: 70% + +Along with the diagrams above, detailed documentation is generated including the role of each component, how to use Nablarch framework features, and implementation points. + +Main use case: Quick understanding of the overall picture when new members join the project. + + +Reliability +============================================ + +**Answers Based Only on Official Documentation** + Knowledge files are created through rule-based transformation of official Nablarch documentation. + AI does not introduce external information through web search or speculation; answer sources are always limited to official information. + +**Clearly States When Information Is Unavailable** + For questions without information in the knowledge files, explicitly states "Not included in knowledge files." + Never returns incorrect answers through plausible speculation. + +**Always Provides Section-Level References in Answers** + All answers clearly indicate their sources, allowing immediate verification of AI answer accuracy. + + **Reference Presentation Structure** + * Line 1: Page title (e.g., HTTP Error Control Handler, etc.) + * Line 2: File path (.md knowledge file) + * Line 3: Title of each cited section + + +Supported Versions +============================================ + +This plugin supports the following Nablarch versions. + +.. list-table:: + :header-rows: 1 + :widths: 60, 40 + + * - Supported Version + - Plugin + * - Nablarch 6u3 + - `nabledge-6(External site) `_ + * - Nablarch 5u26 + - `nabledge-5(External site) `_ + * - Nablarch 1.4.11 + - `nabledge-1.4(External site) `_ + * - Nablarch 1.3.7 + - `nabledge-1.3(External site) `_ + * - Nablarch 1.2.8 + - `nabledge-1.2(External site) `_ + +Installation +============================================ + +This plugin is freely available as OSS on GitHub. +It can be easily installed by executing a single command in the terminal. + +For Nablarch 5 +-------------------------------------------- + +Execute the following command in the terminal:: + + curl -sSL https://raw.githubusercontent.com/nablarch/nabledge/main/setup-cc.sh | bash -s -- -v 5 + +or:: + + curl -sSL https://raw.githubusercontent.com/nablarch/nabledge/main/setup-ghc.sh | bash -s -- -v 5 + +This will make the ``/n5`` command available. + +For Other Versions +-------------------------------------------- + +Click the link in the **Plugin** column for your Nablarch version to view the setup procedure. + diff --git a/en/development_tools/index.rst b/en/development_tools/index.rst index 189e29f5d..cda407f05 100644 --- a/en/development_tools/index.rst +++ b/en/development_tools/index.rst @@ -10,3 +10,4 @@ Nablarch development tools ui_dev/index testing_framework/index toolbox/index + ai_tools/index diff --git a/en/index.rst b/en/index.rst index 048f635d8..f8799493d 100644 --- a/en/index.rst +++ b/en/index.rst @@ -58,9 +58,18 @@ Nablarch development tool ----------------------------------------------- | :doc:`Efficient java static checks ` - | :doc:`Front-end UI development platform for advanced users ` | :doc:`Testing framework ` - | :doc:`Useful tools for developing applications ` + | :doc:`Useful tools for developing applications ` + | :doc:`AI Coding Assistance ` + +.. tip:: + **🤖 Accelerate Nablarch Development with AI** + + With the :doc:`Nablarch-specific AI Coding Tool Plugin `, + you can instantly check Nablarch specifications and implementation methods by simply typing ``/n5`` + in Claude Code / GitHub Copilot. + + For more details, see :doc:`AI Coding Assistance `. ----------------------------------------------- Useful content for development in Nablarch diff --git a/ja/development_tools/ai_tools/index.rst b/ja/development_tools/ai_tools/index.rst new file mode 100644 index 000000000..c7e2759ba --- /dev/null +++ b/ja/development_tools/ai_tools/index.rst @@ -0,0 +1,28 @@ + +============================================ +AIコーディング支援 +============================================ + +.. toctree:: + :maxdepth: 1 + :hidden: + + nabledge/index + +本書では、Nablarch開発をサポートするAIツールを紹介する。|br| + + +.. list-table:: + :header-rows: 1 + :class: white-space-normal + :widths: 1,2 + + * - ツール名 + - 説明 + * - :doc:`nabledge/index` + - | Nablarchの仕様・ベストプラクティスをAIが参照可能にした `Claude Code(外部サイト) `_ / `GitHub Copilot(外部サイト) `_ 向けプラグイン。 + | 質問応答とコード分析で開発支援を実現。 + +.. |br| raw:: html + +
diff --git a/ja/development_tools/ai_tools/nabledge/_image/nabledge_class_dependency_diagram.png b/ja/development_tools/ai_tools/nabledge/_image/nabledge_class_dependency_diagram.png new file mode 100644 index 000000000..d1e56f12d Binary files /dev/null and b/ja/development_tools/ai_tools/nabledge/_image/nabledge_class_dependency_diagram.png differ diff --git a/ja/development_tools/ai_tools/nabledge/_image/nabledge_knowledge_search_example.png b/ja/development_tools/ai_tools/nabledge/_image/nabledge_knowledge_search_example.png new file mode 100644 index 000000000..e2b3abe47 Binary files /dev/null and b/ja/development_tools/ai_tools/nabledge/_image/nabledge_knowledge_search_example.png differ diff --git a/ja/development_tools/ai_tools/nabledge/_image/nabledge_sequence_diagram.png b/ja/development_tools/ai_tools/nabledge/_image/nabledge_sequence_diagram.png new file mode 100644 index 000000000..ba81b4b4f Binary files /dev/null and b/ja/development_tools/ai_tools/nabledge/_image/nabledge_sequence_diagram.png differ diff --git a/ja/development_tools/ai_tools/nabledge/index.rst b/ja/development_tools/ai_tools/nabledge/index.rst new file mode 100644 index 000000000..32c5fd894 --- /dev/null +++ b/ja/development_tools/ai_tools/nabledge/index.rst @@ -0,0 +1,173 @@ + +========================================================================== +Nablarch専用AIコーディングツール向けプラグイン +========================================================================== + +.. contents:: 目次 + :depth: 2 + :local: + + +前提環境 +========================================================================== + +本プラグインの利用には、`Claude Code(外部サイト) `_ または `GitHub Copilot(外部サイト) `_ が必要である。 + + +Nablarch専用AIコーディングツール向けプラグインとは +========================================================================== + +Nablarch専用AIコーディングツール向けプラグインは、Nablarch公式解説書・システム開発ガイド・サンプルプロジェクトの知識を搭載したAIアシスタントである。 +Claude Code または GitHub Copilot のプラグインとして動作し、Nablarch固有の仕様・作法を正確に回答する。 + +背景 +-------------------------------------------- + +近年、生成AIが開発現場に急速に浸透し、開発者は日常的にAIを活用している。 +しかし、Nablarchの情報はWEB上で複数の情報源に分散しており、横断的な理解が必要である。 +そのため、生成AIはNablarch固有の仕様と作法を正確に回答できない。 + +よくある開発現場での困りごと +-------------------------------------------- + +Nablarch開発でこんな経験はないだろうか？ + +* 「あの設定、どの解説書に載ってたっけ？」 +* 「このAPIの使い方、公式ドキュメントを何ページも行ったり来たり…」 +* 「AIに聞いても、存在しないメソッドを提案されて余計に混乱する」 +* 「メンバーへのNablarch説明に時間を取られて設計が進まない」 + +本プラグインで解決 +-------------------------------------------- + +本プラグインを導入すると、Claude Code または GitHub Copilot Chat で ``/n5`` と入力して質問するだけで、Nablarchの仕様・作法を根拠付きでAIが即答する。 + + + +提供する機能 +============================================ + +知識検索 +-------------------------------------------- + +Nablarchのドキュメントに基づいて質問に回答する。 + +使用例： :: + + /n5 コード値のプルダウン入力を実装するには？ + +Nablarchのドキュメント全体から関連セクションを検索し、コード例・設定例を含めた回答を返す。 + +**回答例** + +.. image:: _image/nabledge_knowledge_search_example.png + :alt: 知識検索の回答例 + :scale: 80% + +仕組み： + +* Nablarch公式ドキュメントをAIが読めるJSON形式に変換 +* キーワード全文検索＋AIによる関連度判定の2段階で精度を確保 +* 全文検索でヒットしない場合は目次からAIがファイルを選択するフォールバック経路あり + +コード分析 +-------------------------------------------- + +プロジェクト内のアプリケーションコードをNablarchの観点から分析し、全体像をドキュメント化する。 + +使用例： :: + + /n5 code-analysis + +以下の情報を可視化： + +* クラス間の依存関係 +* ハンドラキューの構成 +* 処理フロー（Mermaid図） + +**出力例** + +クラス依存関係図とコンポーネント概要: + +.. image:: _image/nabledge_class_dependency_diagram.png + :alt: クラス依存関係図とコンポーネント概要 + :scale: 70% + +処理フロー図（シーケンス図）: + +.. image:: _image/nabledge_sequence_diagram.png + :alt: 処理フロー図 + :scale: 70% + +上記のような図と合わせて、各コンポーネントの役割、Nablarchフレームワーク機能の使い方、実装ポイントなども含めた詳細なドキュメントが生成される。 + +主な活用シーン：新メンバーがプロジェクトに入ったときの素早い全体把握。 + + +特徴 +============================================ + +**公式ドキュメントのみを根拠にした回答** + 知識ファイルは、Nablarch公式ドキュメントをルールベース変換して作成している。 + AIがWEB検索や推測で外部情報を持ち込むことはなく、回答の根拠は常に公式情報に限られる。 + +**わからないことは「わからない」と回答** + 知識ファイルに情報がない質問には、「知識ファイルに含まれていません」と明示する。 + もっともらしい推測で誤った回答を返すことがない。 + +**回答に必ずセクション単位の参照元を提示** + すべての回答に参照元を明示することで、AIの回答が正確かどうかを即座に確認可能である。 + + **参照元の提示構成** + * 1行目: ページタイトル（例: HTTPエラー制御ハンドラ、など） + * 2行目: ファイルパス（.md知識ファイル） + * 3行目: 引用した各セクションのタイトル + + +対応バージョン +============================================ + +本プラグインは以下のNablarchバージョンに対応している。 + +.. list-table:: + :header-rows: 1 + :widths: 60, 40 + + * - 対応バージョン + - プラグイン + * - Nablarch 6u3 + - `nabledge-6(外部サイト) `_ + * - Nablarch 5u26 + - `nabledge-5(外部サイト) `_ + * - Nablarch 1.4.11 + - `nabledge-1.4(外部サイト) `_ + * - Nablarch 1.3.7 + - `nabledge-1.3(外部サイト) `_ + * - Nablarch 1.2.8 + - `nabledge-1.2(外部サイト) `_ + +インストール方法 +============================================ + +本プラグインは GitHub 上で OSS として無償公開している。 +ターミナルでコマンド1つ実行することで簡単にインストールできる。 + +Nablarch 5 の場合 +-------------------------------------------- + +以下のコマンドをターミナルで実行する:: + + curl -sSL https://raw.githubusercontent.com/nablarch/nabledge/main/setup-cc.sh | bash -s -- -v 5 + +または:: + + curl -sSL https://raw.githubusercontent.com/nablarch/nabledge/main/setup-ghc.sh | bash -s -- -v 5 + +これで ``/n5`` コマンドが利用可能になる。 + +その他のバージョンの場合 +-------------------------------------------- + +対応バージョン表の「プラグイン」列のリンクから、該当するバージョンの手順を確認すること。 + + diff --git a/ja/development_tools/index.rst b/ja/development_tools/index.rst index c9051d5f3..2d684a11f 100644 --- a/ja/development_tools/index.rst +++ b/ja/development_tools/index.rst @@ -10,3 +10,4 @@ Nablarch開発ツール ui_dev/index testing_framework/index toolbox/index + ai_tools/index diff --git a/ja/index.rst b/ja/index.rst index 5c0f4a0a6..a443d8595 100644 --- a/ja/index.rst +++ b/ja/index.rst @@ -59,10 +59,19 @@ Nablarch拡張コンポーネント Nablarch開発ツール ----------------------------------------------- - | :doc:`効率的なJava静的チェック ` - | :doc:`フロントエンド上級者向けのUI開発基盤 ` + | :doc:`効率的なJava静的チェック ` | :doc:`テスティングフレームワーク ` - | :doc:`アプリケーション開発時に使える便利なツール ` + | :doc:`アプリケーション開発時に使える便利なツール ` + | :doc:`AIコーディング支援 ` + +.. tip:: + **🤖 Nablarch開発をAIで加速** + + :doc:`Nablarch専用AIコーディングツール向けプラグイン ` を使えば、 + Claude Code / GitHub Copilot で ``/n5`` と入力するだけで、 + Nablarchの仕様・実装方法を即座に確認できます。 + + 詳しくは :doc:`AIコーディング支援 ` をご覧ください。 ----------------------------------------------- Nablarchでの開発に役立つコンテンツ