論文の概要: Supporting Software Maintenance with Dynamically Generated Document Hierarchies
- arxiv url: http://arxiv.org/abs/2408.05829v1
- Date: Sun, 11 Aug 2024 17:11:14 GMT
- ステータス: 処理完了
- システム内更新日: 2024-08-13 15:15:52.383038
- Title: Supporting Software Maintenance with Dynamically Generated Document Hierarchies
- Title(参考訳): 動的に生成されたドキュメント階層によるソフトウェアメンテナンスのサポート
- Authors: Katherine R. Dearstyne, Alberto D. Rodriguez, Jane Cleland-Huang,
- Abstract要約: HGENは、ソースコードを6つのステージで変換し、構造化された文書の階層構造に変換する、完全に自動化されたパイプラインである。
我々はHGENを定量的にも質的にも評価した。
その結果,HGENは手作業で構築したドキュメントに類似したアーティファクト階層を生成し,コアコンセプトをベースラインアプローチよりもはるかに高いカバレッジで実現していることがわかった。
- 参考スコア(独自算出の注目度): 41.407915858583344
- License: http://arxiv.org/licenses/nonexclusive-distrib/1.0/
- Abstract: Software documentation supports a broad set of software maintenance tasks; however, creating and maintaining high-quality, multi-level software documentation can be incredibly time-consuming and therefore many code bases suffer from a lack of adequate documentation. We address this problem through presenting HGEN, a fully automated pipeline that leverages LLMs to transform source code through a series of six stages into a well-organized hierarchy of formatted documents. We evaluate HGEN both quantitatively and qualitatively. First, we use it to generate documentation for three diverse projects, and engage key developers in comparing the quality of the generated documentation against their own previously produced manually-crafted documentation. We then pilot HGEN in nine different industrial projects using diverse datasets provided by each project. We collect feedback from project stakeholders, and analyze it using an inductive approach to identify recurring themes. Results show that HGEN produces artifact hierarchies similar in quality to manually constructed documentation, with much higher coverage of the core concepts than the baseline approach. Stakeholder feedback highlights HGEN's commercial impact potential as a tool for accelerating code comprehension and maintenance tasks. Results and associated supplemental materials can be found at https://zenodo.org/records/11403244
- Abstract(参考訳): ソフトウェアドキュメンテーションはソフトウェアの保守タスクを幅広くサポートしていますが、高品質でマルチレベルなソフトウェアドキュメンテーションの作成とメンテナンスには信じられないほど時間がかかるため、多くのコードベースが適切なドキュメンテーションの欠如に悩まされています。
HGENは、LLMを活用してソースコードを6つのステージで変換し、構造化された文書の階層構造に変換する、完全に自動化されたパイプラインである。
我々はHGENを定量的にも質的にも評価した。
まず、これを3つの多様なプロジェクト用のドキュメンテーションの生成に使用し、生成したドキュメンテーションの質を以前に手作業で作成したドキュメンテーションと比較する上で重要な開発者を巻き込みます。
次に、各プロジェクトが提供するさまざまなデータセットを使用して、9つの異なる産業プロジェクトにおいてHGENを試験します。
プロジェクトステークホルダーからのフィードバックを収集し、反復するテーマを特定するための帰納的アプローチを用いて分析する。
その結果,HGENは手作業で構築したドキュメントに類似したアーティファクト階層を生成し,コアコンセプトをベースラインアプローチよりもはるかに高いカバレッジで実現していることがわかった。
Stakeholder氏のフィードバックは、コード理解とメンテナンスタスクを加速するためのツールとして、HGENの商業的影響の可能性を強調している。
結果はhttps://zenodo.org/records/11403244で見ることができる。
関連論文リスト
- Linking Code and Documentation Churn: Preliminary Analysis [2.033674689332928]
本研究では,GitHubの3つのオープンソースプロジェクトにおけるコードチャーンとドキュメント更新の同期について検討する。
予備的な結果は、プロジェクト間で異なる同期度を示し、統合された並行ドキュメントプラクティスの重要性を強調します。
この研究の斬新さは、コードの変更とドキュメントの更新を同期させることが、多様性と効率を向上させることで、開発ライフサイクルをいかに改善できるかを示すことである。
論文 参考訳(メタデータ) (2024-10-08T12:41:58Z) - HDT: Hierarchical Document Transformer [70.2271469410557]
HDTは補助的なアンカートークンを導入し、アテンション機構をスパースなマルチレベル階層に再設計することでドキュメント構造を利用する。
文書の階層構造を考慮した新しいスパークアテンションカーネルを開発した。
論文 参考訳(メタデータ) (2024-07-11T09:28:04Z) - DocGenome: An Open Large-scale Scientific Document Benchmark for Training and Testing Multi-modal Large Language Models [63.466265039007816]
我々は、arXivオープンアクセスコミュニティの153の分野から500Kの科学文書を注釈付けして構築した構造化文書ベンチマークDocGenomeを提案する。
我々はDocGenomeの利点を実証するために広範な実験を行い、我々のベンチマークで大規模モデルの性能を客観的に評価した。
論文 参考訳(メタデータ) (2024-06-17T15:13:52Z) - Automated User Story Generation with Test Case Specification Using Large Language Model [0.0]
要件文書からユーザストーリーを自動生成するツール「GeneUS」を開発した。
アウトプットはフォーマットで提供され、ダウンストリーム統合の可能性は人気のあるプロジェクト管理ツールに開放されます。
論文 参考訳(メタデータ) (2024-04-02T01:45:57Z) - RepoAgent: An LLM-Powered Open-Source Framework for Repository-level
Code Documentation Generation [79.83270415843857]
コードドキュメンテーションを積極的に生成、保守、更新することを目的とした、大規模な言語モデルによるオープンソースフレームワークであるRepoAgentを紹介します。
RepoAgentは高品質なリポジトリレベルのドキュメントを生成するのに優れています。
論文 参考訳(メタデータ) (2024-02-26T15:39:52Z) - On Task-personalized Multimodal Few-shot Learning for Visually-rich
Document Entity Retrieval [59.25292920967197]
VDER(Few-shot document entity search)は、NLPアプリケーションにおいて重要なトピックである。
FewVEXは、エンティティレベルの少数ショットVDERの分野における将来の研究を促進するための、新しいデータセットである。
本稿では,タスクパーソナライズを効果的に実現することを中心に,タスク認識型メタラーニングベースのフレームワークを提案する。
論文 参考訳(メタデータ) (2023-11-01T17:51:43Z) - A Study of Documentation for Software Architecture [7.011803832284996]
私たちは65人の参加者に、ソフトウェアアーキテクチャの理解に関する質問に答えるように頼みました。
アクティビティの適用と作成を必要とする質問に対する回答は、システムのソースコードの使用と統計的に大きく関連している。
本研究の結果は,建築文書の形式が重要であるという仮説と矛盾するものである。
論文 参考訳(メタデータ) (2023-05-26T22:14:53Z) - HADES: Homologous Automated Document Exploration and Summarization [3.3509104620016092]
HADESは大量の文書を扱う専門家の仕事の合理化を目的としている。
このツールは、トピックモデリング、要約、トピック毎の最も重要な単語の解析を用いてPDF文書の処理から始まる多段階パイプラインを使用する。
論文 参考訳(メタデータ) (2023-02-25T15:16:10Z) - Generate rather than Retrieve: Large Language Models are Strong Context
Generators [74.87021992611672]
本稿では,文書検索を大規模言語モデル生成器に置き換えることで,知識集約型タスクを解く新しい視点を提案する。
我々は,提案手法をgenRead (genRead) と呼び,まず大きな言語モデルに対して,与えられた質問に基づいて文脈文書を生成し,次に生成された文書を読み出して最終回答を生成する。
論文 参考訳(メタデータ) (2022-09-21T01:30:59Z)
関連論文リストは本サイト内にある論文のタイトル・アブストラクトから自動的に作成しています。
指定された論文の情報です。
本サイトの運営者は本サイト(すべての情報・翻訳含む)の品質を保証せず、本サイト(すべての情報・翻訳含む)を使用して発生したあらゆる結果について一切の責任を負いません。