論文の概要: Towards identifying and minimizing customer-facing documentation debt
- arxiv url: http://arxiv.org/abs/2402.11048v1
- Date: Fri, 16 Feb 2024 19:51:04 GMT
- ステータス: 処理完了
- システム内更新日: 2024-02-20 23:51:02.027222
- Title: Towards identifying and minimizing customer-facing documentation debt
- Title（参考訳）: 顧客向けドキュメント負債の特定と最小化に向けて
- Authors: Lakmal Silva, Michael Unterkalmsteiner, Krzysztof Wnuk
- Abstract要約: 正確で完全で最新のドキュメントが不足すると、ドキュメントの欠陥が増加します。
ドキュメンテーションの欠陥に寄与するドキュメンテーションの欠陥タイプを特定し、ドキュメンテーションの負債を特定します。
実際には、ドキュメントの負債は、大量のリソースと焦点が高品質なソフトウェアを提供することに集中しているため、簡単に検出できなくなります。
- 参考スコア（独自算出の注目度）: 5.318531077716712
- License: http://creativecommons.org/licenses/by-nc-sa/4.0/
- Abstract: Software documentation often struggles to catch up with the pace of software
evolution. The lack of correct, complete, and up-to-date documentation results
in an increasing number of documentation defects which could introduce delays
in integrating software systems. In our previous study on a bug analysis tool
called MultiDimEr, we provided evidence that documentation-related defects
contribute to many bug reports. First, we want to identify documentation defect
types contributing to documentation defects, thereby identifying documentation
debt. Secondly, we aim to find pragmatic solutions to minimize most common
documentation defects to pay off the documentation debt in the long run. We
investigated documentation defects related to an industrial software system.
First, we looked at different documentation types and associated bug reports.
We categorized the defects according to an existing documentation defect
taxonomy. Based on a sample of 101 defects, we found that most defects are
caused by documentation defects falling into the Information Content (What)
category (86). Within this category, the documentation defect types Erroneous
code examples (23), Missing documentation (35), and Outdated content (19)
contributed to most of the documentation defects. We propose to adapt two
solutions to mitigate these types of documentation defects. In practice,
documentation debt can easily go undetected since a large share of resources
and focus is dedicated to delivering high-quality software. We suggest adapting
two main solutions to tackle documentation debt by implementing (i) Dynamic
Documentation Generation (DDG) and/or (ii) Automated Documentation Testing
(ADT), which are both based on defining a single and robust information source
for documentation.
- Abstract（参考訳）: ソフトウェアドキュメントは、しばしばソフトウェア進化のペースに追いつくのに苦労します。
正し、完全で、最新のドキュメントの欠如により、ソフトウェアシステム統合に遅延をもたらす可能性のある、ドキュメントの欠陥が増えている。
前回のMultiDimErというバグ解析ツールの研究で、文書関連欠陥が多くのバグレポートに寄与する証拠を提供した。
まず、ドキュメントの欠陥に寄与するドキュメントの欠陥タイプを特定し、ドキュメントの負債を特定したいのです。
次に、最も一般的なドキュメントの欠陥を最小限に抑えるための実用的なソリューションを見つけ、ドキュメントの負債を長期的に返済することを目指しています。
産業ソフトウェアシステムに関連する文書欠陥を調査した。
まず、さまざまなドキュメンテーションタイプと関連するバグレポートを調べました。
既存の文書欠陥分類に従って欠陥を分類した。
101の欠陥のサンプルに基づいて、ほとんどの欠陥がドキュメントの欠陥が情報コンテンツ(what)カテゴリ(86)に落ち込んでいることが分かりました。
このカテゴリでは、ドキュメントの欠陥タイプは誤ったコード例(23)、ドキュメントの欠如(35)、古いコンテンツ(19)がドキュメントの欠陥のほとんどに寄与した。
この種のドキュメンテーションの欠陥を軽減するために、2つのソリューションを適用することを提案する。
実際には、大量のリソースと焦点が高品質なソフトウェアの提供に集中しているため、ドキュメントの負債は容易に検出できない。
私たちはドキュメント負債に対処するために2つの主要な解決策を適用することを提案します。
一 動的文書生成(DDG)及び/又は
(ii) 自動化ドキュメンテーションテスト(adt)は、ドキュメンテーションのための単一のロバストな情報ソースを定義することに基づいている。
関連論文リスト
- Supporting Software Maintenance with Dynamically Generated Document Hierarchies [41.407915858583344]
HGENは、ソースコードを6つのステージで変換し、構造化された文書の階層構造に変換する、完全に自動化されたパイプラインである。
我々はHGENを定量的にも質的にも評価した。
その結果,HGENは手作業で構築したドキュメントに類似したアーティファクト階層を生成し,コアコンセプトをベースラインアプローチよりもはるかに高いカバレッジで実現していることがわかった。
論文 参考訳（メタデータ） (2024-08-11T17:11:14Z) - Managing Human-Centric Software Defects: Insights from GitHub and Practitioners' Perspectives [8.285109854002307]
HCD(Human-centric defect)は、エンドユーザの認識や違いによってしばしば発生する、ニュアンスで主観的な欠陥である。
開発チームはこれらの問題に対する理解が限られており、これらの欠陥を無視することになります。
欠陥報告ツールは、HCDのキャプチャと修正を適切に処理しない。
論文 参考訳（メタデータ） (2024-08-03T01:08:38Z) - GenAudit: Fixing Factual Errors in Language Model Outputs with Evidence [64.95492752484171]
GenAudit - 文書基底タスクの事実チェック LLM 応答を支援するためのツール。
これらのタスクを実行するためにモデルをトレーニングし、ユーザに対して推奨の編集とエビデンスを示すインタラクティブインターフェースを設計します。
システムによってほとんどのエラーがフラグ付けされていることを保証するため,精度への影響を最小限に抑えつつエラーリコールを増大させる手法を提案する。
論文 参考訳（メタデータ） (2024-02-19T21:45:55Z) - IncDSI: Incrementally Updatable Document Retrieval [35.5697863674097]
IncDSIは、データセット全体のモデルをトレーニングすることなく、リアルタイムでドキュメントを追加する方法である。
我々は、制約付き最適化問題として文書の追加を定式化し、ネットワークパラメータの変更を最小限に抑える。
私たちのアプローチは、データセット全体のモデルの再トレーニングと競合しています。
論文 参考訳（メタデータ） (2023-07-19T07:20:30Z) - Unified Pretraining Framework for Document Understanding [52.224359498792836]
文書理解のための統合事前学習フレームワークであるUDocを紹介する。
UDocは、ほとんどのドキュメント理解タスクをサポートするように設計されており、Transformerを拡張してマルチモーダル埋め込みを入力とする。
UDocの重要な特徴は、3つの自己管理的損失を利用して汎用的な表現を学ぶことである。
論文 参考訳（メタデータ） (2022-04-22T21:47:04Z) - GERE: Generative Evidence Retrieval for Fact Verification [57.78768817972026]
本稿では,ジェネレーション方式で証拠を検索する最初のシステムであるGEREを提案する。
FEVERデータセットの実験結果は、GEREが最先端のベースラインよりも大幅に改善されていることを示している。
論文 参考訳（メタデータ） (2022-04-12T03:49:35Z) - Fourier Document Restoration for Robust Document Dewarping and
Recognition [73.44057202891011]
本稿では、異なる歪みで文書を復元できるフーリエ文書復元ネットワークであるFDRNetについて述べる。
ドキュメントをフレキシブルなThin-Plate Spline変換でデワープし、トレーニング時に変形アノテーションを必要とせずに、様々な変形を効果的に処理できる。
これは、デウォープとテキスト認識の両方のタスクにおいて、最先端の技術をはるかに上回る。
論文 参考訳（メタデータ） (2022-03-18T12:39:31Z) - DocScanner: Robust Document Image Rectification with Progressive
Learning [162.03694280524084]
この研究はDocScannerという、文書画像の修正のための新しいディープネットワークアーキテクチャを提示する。
DocScannerは、修正されたイメージの1つの見積を維持し、再帰的なアーキテクチャで徐々に修正される。
反復的な改善によりDocScannerは堅牢で優れたパフォーマンスに収束し、軽量なリカレントアーキテクチャにより実行効率が保証される。
論文 参考訳（メタデータ） (2021-10-28T09:15:02Z) - Timestamping Documents and Beliefs [1.4467794332678539]
文書デートは、文書の時間構造に関する推論を必要とする難しい問題である。
本稿では,グラフ畳み込みネットワーク(GCN)に基づく文書年代測定手法であるNeuralDaterを提案する。
また,注意に基づく文書デートシステムであるAD3: Attentive Deep Document Daterを提案する。
論文 参考訳（メタデータ） (2021-06-09T02:12:18Z) - Fast(er) Reconstruction of Shredded Text Documents via Self-Supervised
Deep Asymmetric Metric Learning [62.34197797857823]
細断文書の自動復元における中心的な問題は、細断文書の相互互換性評価である。
本研究は,推定回数を線形にスケールするペアワイド互換性を測るスケーラブルな深層学習手法を提案する。
提案手法は,505個のシュレッダーを持つテストインスタンスに対して,22倍の高速化を実現した最先端技術に匹敵する精度を有する。
論文 参考訳（メタデータ） (2020-03-23T03:22:06Z)
関連論文リストは本サイト内にある論文のタイトル・アブストラクトから自動的に作成しています。
指定された論文の情報です。
本サイトの運営者は本サイト（すべての情報・翻訳含む）の品質を保証せず、本サイト（すべての情報・翻訳含む）を使用して発生したあらゆる結果について一切の責任を負いません。