特許ウォッチ

公開番号2025141346
公報種別公開特許公報(A)
公開日2025-09-29
出願番号2024041240
出願日2024-03-15
発明の名称ドキュメント生成装置、ドキュメント生成方法
出願人株式会社日立製作所
代理人弁理士法人サンネクスト国際特許事務所
主分類G06F 8/73 20180101AFI20250919BHJP(計算;計数)
要約【課題】代表的なコード以外に関するドキュメントも生成できる。
【解決手段】ドキュメント生成装置は、処理単位を1以上含む入力データを用いて、処理単位を処理する順番である処理順序に従って、処理単位ごとにドキュメント生成部への入力を生成する入力生成部と、入力をドキュメント生成部へ入力して処理単位に関するドキュメントをドキュメント生成部から取得するドキュメント取得部と、を備える。
【選択図】図1

特許請求の範囲【請求項１】
処理単位を１以上含む入力データを用いて、前記処理単位を処理する順番である処理順序に従って、前記処理単位ごとにドキュメント生成部への入力を生成する入力生成部と、
前記入力を前記ドキュメント生成部へ入力して前記処理単位に関するドキュメントを前記ドキュメント生成部から取得するドキュメント取得部と、を備える、ドキュメント生成装置。
続きを表示（約 1,000 文字）【請求項２】
請求項１に記載のドキュメント生成装置において、
前記入力データはソースコードである、ドキュメント生成装置。
【請求項３】
請求項１に記載のドキュメント生成装置において、
前記ドキュメント生成部は機械学習モデルである、ドキュメント生成装置。
【請求項４】
請求項１に記載のドキュメント生成装置において、
前記処理単位は関数である、ドキュメント生成装置。
【請求項５】
請求項１に記載のドキュメント生成装置において、
前記入力生成部は、前記入力の生成対象とする前記処理単位である対象単位よりも前記処理順序が前の前記処理単位に関する前記ドキュメント生成部が生成した前記ドキュメントを、必要に応じて前記入力に含める、ドキュメント生成装置。
【請求項６】
請求項１に記載のドキュメント生成装置において、
前記入力生成部は、前記処理単位の種類に応じて前記入力のテンプレートを決定し、前記テンプレートに従い前記入力を生成する、ドキュメント生成装置。
【請求項７】
請求項１に記載のドキュメント生成装置において、
前記入力データを解析して依存グラフを生成し、前記依存グラフに基づき前記処理順序を決定する処理順序決定部をさらに備える、ドキュメント生成装置。
【請求項８】
請求項７に記載のドキュメント生成装置において、
前記依存グラフがコールグラフである、ドキュメント生成装置。
【請求項９】
請求項７または請求項８に記載のドキュメント生成装置において、
前記入力生成部は、前記入力の生成対象とする前記処理単位である対象単位が前記依存グラフにおいて子ノードを有する場合に、前記子ノードについて前記ドキュメント生成部が生成した前記ドキュメントを前記入力に含める、ドキュメント生成装置。
【請求項１０】
請求項７または請求項８に記載のドキュメント生成装置において、
前記ドキュメント生成部は機械学習モデルを含み、
前記入力生成部は、前記入力の生成対象とする前記処理単位である対象単位が前記依存グラフにおいて子ノードを有し、かつ前記子ノードに関するデータを前記ドキュメント生成部が学習していない場合に、前記子ノードについて前記ドキュメント生成部が生成した前記ドキュメントを前記入力に含める、ドキュメント生成装置。
（【請求項１１】以降は省略されています）
発明の詳細な説明【技術分野】
【０００１】
本発明は、キュメント生成装置、およびドキュメント生成方法に関する。
続きを表示（約 2,100 文字）【背景技術】
【０００２】
アジャイル開発の広がりなどにより、ソースコードからドキュメントを生成する技術が求められている。非特許文献１には、レポジトリが実施することの概要を示す代表的なコード断片をヒューリスティクスと弱教師付き学習により抽出することで、大規模言語モデルでreadmeを生成する技術が開示されている。
【先行技術文献】
【特許文献】
【０００３】
是枝祐太、他３名、”大規模言語モデルとヒューリスティクスに基づくreadme生成”、［online］、２０２３年、人工知能学会、２０２４年２月１４日検索、インターネット＜ＵＲＬ：https://www.jstage.jst.go.jp/article/pjsai/JSAI2023/0/JSAI2023_4Xin108/_pdf＞
【発明の概要】
【発明が解決しようとする課題】
【０００４】
特許文献１に記載されている発明では、代表的なコードに関するドキュメント（readme）しか生成できない。
【課題を解決するための手段】
【０００５】
本発明の第１の態様によるドキュメント生成装置は、処理単位を１以上含む入力データを用いて、前記処理単位を処理する順番である処理順序に従って、前記処理単位ごとにドキュメント生成部への入力を生成する入力生成部と、前記入力を前記ドキュメント生成部へ入力して前記処理単位に関するドキュメントを前記ドキュメント生成部から取得するドキュメント取得部と、を備える。
本発明の第２の態様によるドキュメント生成方法は、ドキュメント生成装置が実行するドキュメント生成方法であって、処理単位を１以上含む入力データを用いて、前記処理単位を処理する順番である処理順序に従って、前記処理単位ごとにドキュメント生成部へ入力する文字列である入力を生成することと、前記入力を前記ドキュメント生成部へ入力して前記処理単位に関するドキュメントを前記ドキュメント生成部から取得することを含む。
【発明の効果】
【０００６】
本発明によれば、代表的なコード以外に関するドキュメントも生成できる。
【図面の簡単な説明】
【０００７】
ドキュメント生成装置の機能構成図
ドキュメント生成装置のハードウエア構成図
コードリポジトリの一例を示す図
生成ドキュメントの一例を示す図
コールグラフの一例を示す図
処理順序の一例を示す図
グラフ形式外部ＡＰＩリファレンスの一例を示す図
データ取得関数群の一例を示す図
データ取得関数選択表の一例を示す図
入力テンプレートの一例を示す図
入力テンプレート対応表の一例を示す図
演算部の処理を示すフローチャート
処理順序決定部の処理を示すフローチャート
処理順序決定部の処理を示すイメージ図
入力生成部の処理を示すフローチャート
ユーザが操作するユーザインタフェースを示す図
データ取得方法更新画面の一例を示す図
入力テンプレート更新画面の一例を示す図
ＡＰＩリファレンス更新画面の一例を示す図
変形例２における入力生成部の処理を示すフローチャート
【発明を実施するための形態】
【０００８】
―第１の実施の形態―
以下、図１～図１９を参照して、ドキュメント生成装置およびドキュメント生成方法の第１の実施の形態を説明する。以下に説明するドキュメント生成装置は、入力されるソースコード群を解析して処理単位ごとのドキュメントを生成する。処理単位はたとえば関数、スクリプト、クラス、クラスのメソッドなどである。処理単位は、ソースコードと同等以下の粒度である。
【０００９】
図１は、ドキュメント生成装置１の機能構成図である。ドキュメント生成装置１は、演算部１０およびデータ格納部４を備える。演算部１０は、処理順序決定部１１と、入力生成部１２と、ドキュメント取得部１３と、を備える。データ格納部４には、コードリポジトリ４１、コールグラフ４２、処理順序４３、グラフ形式外部ＡＰＩリファレンス４４、データ取得関数群４５、データ取得関数選択表４６、入力テンプレート４７、入力テンプレート対応表４８、および生成ドキュメント４９が格納される。データ格納部４に格納されるデータの詳細は後述する。
【００１０】
コードリポジトリ４１、グラフ形式外部ＡＰＩリファレンス４４、データ取得関数群４５、データ取得関数選択表４６、入力テンプレート４７、および入力テンプレート対応表４８は、あらかじめ作成されてデータ格納部４に格納される。コールグラフ４２および処理順序４３は、処理順序決定部１１により生成される。生成ドキュメント４９は、後述するドキュメント生成部９９により生成される。コードリポジトリ４１はソースコードを１以上含む。以下ではコードリポジトリ４１を「入力データ」とも呼ぶ。
（【００１１】以降は省略されています）

関連特許