Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
20 commits
Select commit Hold shift + click to select a range
dbf8238
Nabledge(Nablarch 5専用AIツール)ドキュメントページを追加
nakagawa131 Jul 30, 2026
9d08a78
refactor: breadcrumbs.htmlから不要なコメントを削除
nakagawa131 Jul 31, 2026
2b1001a
fix: 対応バージョン表の列名参照を修正
nakagawa131 Jul 31, 2026
4bda719
docs: Nabledgeガイドに出力サンプル画像を追加
nakagawa131 Jul 31, 2026
41421e3
docs: Claude CodeとGitHub Copilotに外部リンクを追加
nakagawa131 Jul 31, 2026
f71c982
docs: 前提環境セクションを冒頭に移動し外部リンクを追加
nakagawa131 Jul 31, 2026
9aa0239
docs: ファイル数・エントリ数の記載を削除
nakagawa131 Jul 31, 2026
14db5b3
docs: インストール手順の構成を改善しコマンドを修正
nakagawa131 Jul 31, 2026
24498ef
docs: 特徴セクションの冗長性を削減
nakagawa131 Jul 31, 2026
2f84bdf
docs: 英語版の表現を自然な英語に修正
nakagawa131 Jul 31, 2026
9bd68dc
fix: 言語切り替えリンクをNablarch 5用に修正
nakagawa131 Jul 31, 2026
be4d52d
fix: 英語版の使用例コマンドを /n5 に修正
nakagawa131 Jul 31, 2026
196790b
fix: 日本語版の使用例コマンドを /n5 に修正
nakagawa131 Jul 31, 2026
ec98a54
fix: 英語版ドキュメントの画像ファイル名を英語に修正
nakagawa131 Aug 2, 2026
96db2a4
fix: Claude Codeの外部リンクを公式製品ページに変更
nakagawa131 Aug 2, 2026
354426d
fix: 日本語版の画像ファイル名を英語に統一
nakagawa131 Aug 4, 2026
626bc77
docs: 箇条書きの並列性を名詞句に統一
nakagawa131 Aug 4, 2026
69b514d
docs: 英語版インストール手順の語順を自然な表現に改善
nakagawa131 Aug 4, 2026
f1619f1
fix: Nabledge画像ファイル名を言語識別子付きに統一
nakagawa131 Aug 5, 2026
bef8a9e
fix: Nabledge画像ファイル名から言語識別子を削除し英語版と日本語版で統一
nakagawa131 Aug 5, 2026
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
28 changes: 28 additions & 0 deletions en/development_tools/ai_tools/index.rst
Original file line number Diff line number Diff line change
@@ -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) <https://claude.com/product/claude-code>`_ / `GitHub Copilot(External site) <https://github.com/features/copilot>`_ that provides AI-powered access to Nablarch specifications and best practices.
| Enables question answering and code analysis for development support.

.. |br| raw:: html

<br />
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
172 changes: 172 additions & 0 deletions en/development_tools/ai_tools/nabledge/index.rst
Original file line number Diff line number Diff line change
@@ -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) <https://claude.com/product/claude-code>`_ or `GitHub Copilot(External site) <https://github.com/features/copilot>`_.


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) <https://github.com/nablarch/nabledge/blob/main/plugins/nabledge-6/README.md>`_
* - Nablarch 5u26
- `nabledge-5(External site) <https://github.com/nablarch/nabledge/blob/main/plugins/nabledge-5/README.md>`_
* - Nablarch 1.4.11
- `nabledge-1.4(External site) <https://github.com/nablarch/nabledge/blob/main/plugins/nabledge-1.4/README.md>`_
* - Nablarch 1.3.7
- `nabledge-1.3(External site) <https://github.com/nablarch/nabledge/blob/main/plugins/nabledge-1.3/README.md>`_
* - Nablarch 1.2.8
- `nabledge-1.2(External site) <https://github.com/nablarch/nabledge/blob/main/plugins/nabledge-1.2/README.md>`_

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.

1 change: 1 addition & 0 deletions en/development_tools/index.rst
Original file line number Diff line number Diff line change
Expand Up @@ -10,3 +10,4 @@ Nablarch development tools
ui_dev/index
testing_framework/index
toolbox/index
ai_tools/index
13 changes: 11 additions & 2 deletions en/index.rst
Original file line number Diff line number Diff line change
Expand Up @@ -58,9 +58,18 @@ Nablarch development tool
-----------------------------------------------

| :doc:`Efficient java static checks <development_tools/java_static_analysis/index>`
| :doc:`Front-end UI development platform for advanced users <development_tools/ui_dev/index>`
| :doc:`Testing framework <development_tools/testing_framework/index>`
| :doc:`Useful tools for developing applications <development_tools/toolbox/index>`
| :doc:`Useful tools for developing applications <development_tools/toolbox/index>`
| :doc:`AI Coding Assistance <development_tools/ai_tools/index>`

.. tip::
**🤖 Accelerate Nablarch Development with AI**

With the :doc:`Nablarch-specific AI Coding Tool Plugin <development_tools/ai_tools/nabledge/index>`,
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 <development_tools/ai_tools/index>`.

-----------------------------------------------
Useful content for development in Nablarch
Expand Down
28 changes: 28 additions & 0 deletions ja/development_tools/ai_tools/index.rst
Original file line number Diff line number Diff line change
@@ -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(外部サイト) <https://claude.com/ja/product/claude-code>`_ / `GitHub Copilot(外部サイト) <https://github.com/features/copilot>`_ 向けプラグイン。
| 質問応答とコード分析で開発支援を実現。

.. |br| raw:: html

<br />
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading