論文の概要: "Add more config detail": A Taxonomy of Installation Instruction Changes
- arxiv url: http://arxiv.org/abs/2312.03250v2
- Date: Sun, 14 Jul 2024 14:37:33 GMT
- ステータス: 処理完了
- システム内更新日: 2024-07-17 02:44:20.712208
- Title: "Add more config detail": A Taxonomy of Installation Instruction Changes
- Title（参考訳）: 『追加構成詳細』:設置指示の変更分類
- Authors: Haoyu Gao, Christoph Treude, Mansooreh Zahedi,
- Abstract要約: インストール関連セクションの更新に重点を置いた1,163のコミットでGitHubリポジトリを調査した。
調査の結果,コミットの変更には,プリインストール命令,インストール後のインストレーション命令,ドキュメント提示,外部リソース管理の6つの大きなカテゴリが明らかになった。
そこで本稿では,ドキュメント更新時にドキュメンテーションメンテナが参照するインストール関連セクションをカバーするテンプレートを提案する。
- 参考スコア（独自算出の注目度）: 9.982895603207993
- License: http://arxiv.org/licenses/nonexclusive-distrib/1.0/
- Abstract: README files play an important role in providing installation-related instructions to software users and are widely used in open source software systems on platforms such as GitHub. However, these files often suffer from various documentation issues, leading to challenges in comprehension and potential errors in content. Despite their significance, there is a lack of systematic understanding regarding the documentation efforts invested in README files, especially in the context of installation-related instructions, which are crucial for users to start with a software project. To fill the research gap, we conducted a qualitative study, investigating 400 GitHub repositories with 1,163 README commits that focused on updates in installation-related sections. Our research revealed six major categories of changes in the README commits, namely pre-installation instructions, installation instructions, post-installation instructions, help information updates, document presentation, and external resource management. We further provide detailed insights into modification behaviours and offer examples of these updates. Based on our findings, we propose a README template tailored to cover the installation-related sections for documentation maintainers to reference when updating documents. We further validate this template by conducting an online survey, identifying that documentation readers find the augmented documents based on our template are generally of better quality. We further provide recommendations to practitioners for maintaining their README files, as well as motivations for future research directions... (too long for arxiv)
- Abstract（参考訳）: READMEファイルは、ソフトウェアユーザにインストール関連の指示を提供する上で重要な役割を担い、GitHubなどのプラットフォーム上のオープンソースソフトウェアシステムで広く利用されている。
しかし、これらのファイルは、しばしば様々なドキュメントの問題に悩まされ、コンテンツの理解と潜在的なエラーを引き起こす。
それらの重要性にもかかわらず、READMEファイル、特にユーザーがソフトウェアプロジェクトを始めるのに不可欠であるインストール関連命令の文脈において、READMEファイルに費やされたドキュメントの取り組みに関する体系的な理解が欠如している。
調査ギャップを埋めるため、インストール関連セクションのアップデートに焦点を当てた1,163のREADMEコミットで400のGitHubリポジトリを調査し、質的な調査を行った。
本研究は,READMEコミットの変更点として,プリインストール指示,インストール指示,ポストインストール指示,ヘルプ情報更新,ドキュメント提示,外部リソース管理の6つの主要なカテゴリを明らかにした。
さらに、修正行動に関する詳細な洞察を提供し、これらの更新の例を示します。
そこで本研究では,文書更新時にドキュメンテーションメンテナが参照するインストール関連セクションをカバーするためのREADMEテンプレートを提案する。
我々は、オンライン調査を実施して、このテンプレートをさらに検証し、ドキュメンテーションの読者が、テンプレートに基づいた拡張ドキュメントが一般的に、より良い品質であることを確認する。
さらに,READMEファイルの維持や今後の研究方向性のモチベーション(arxivには長すぎる)について,実践者に推奨する。
関連論文リスト
- Supporting Software Maintenance with Dynamically Generated Document Hierarchies [41.407915858583344]
HGENは、ソースコードを6つのステージで変換し、構造化された文書の階層構造に変換する、完全に自動化されたパイプラインである。
我々はHGENを定量的にも質的にも評価した。
その結果,HGENは手作業で構築したドキュメントに類似したアーティファクト階層を生成し,コアコンセプトをベースラインアプローチよりもはるかに高いカバレッジで実現していることがわかった。
論文 参考訳（メタデータ） (2024-08-11T17:11:14Z) - DOCBENCH: A Benchmark for Evaluating LLM-based Document Reading Systems [99.17123445211115]
本稿では,大規模言語モデル(LLM)に基づく文書読解システムを評価するベンチマークであるDocBenchを紹介する。
我々のベンチマークには、人間のアノテーションの募集と、合成質問の生成が含まれる。
実際の文書は229件、質問は1,102件で、5つのドメインにまたがって4種類の質問がある。
論文 参考訳（メタデータ） (2024-07-15T13:17:42Z) - LayoutLLM: Layout Instruction Tuning with Large Language Models for Document Understanding [21.916774808384893]
提案手法は,レイアウト対応事前学習とレイアウト対応監視ファインタニングの2つのコンポーネントから構成される。
標準ベンチマークの実験では、提案されたLayoutLLMは、文書理解のためにオープンソースの7B LLMs/MLLMを採用する既存の手法よりも大幅に優れていた。
論文 参考訳（メタデータ） (2024-04-08T06:40:28Z) - FollowIR: Evaluating and Teaching Information Retrieval Models to Follow Instructions [71.5977045423177]
本稿では,情報検索システムにおける命令の利用について検討する。
厳密なインストラクション評価ベンチマークを含むデータセットFollowIRを紹介した。
我々は、IRモデルが複雑な命令に従うことを学習することは可能であることを示す。
論文 参考訳（メタデータ） (2024-03-22T14:42:29Z) - Beyond the Chat: Executable and Verifiable Text-Editing with LLMs [87.84199761550634]
近年,Large Language Models (LLMs) を利用した会話インタフェースが,文書編集時にフィードバックを得る手段として人気になっている。
InkSyncは、編集中のドキュメント内で直接実行可能な編集を推奨する編集インターフェースである。
論文 参考訳（メタデータ） (2023-09-27T00:56:17Z) - Evaluating Transfer Learning for Simplifying GitHub READMEs [11.219774223416648]
本研究は,GitHubファイルを自動的に単純化する,ソフトウェア工学領域におけるテキスト簡略化手法の可能性を探るものである。
14,588のエントリで構成された、ソフトウェア関連のGitHubファイルのペアを収集し、単純化された文と整列させ、難しいバージョンを自動的に単純化するためにTransformerベースのモデルをトレーニングしました。
自動BLEUスコアと人的評価を用いて,トランスファー学習方式とベースラインモデルの性能を比較した。
論文 参考訳（メタデータ） (2023-08-19T08:20:41Z) - mPLUG-DocOwl: Modularized Multimodal Large Language Model for Document
Understanding [55.4806974284156]
文書理解とは、ウェブページのようなデジタル文書から自動的に情報を抽出し、分析し、理解することである。
既存のMLLM(Multi-model Large Language Models)は、浅いOCRフリーテキスト認識において、望ましくないゼロショット機能を実証している。
論文 参考訳（メタデータ） (2023-07-04T11:28:07Z) - Envisioning the Next-Gen Document Reader [41.35737889497044]
我々は、ユーザ理解を高め、よりつながりのある信頼できる情報体験を作り出すために、次世代のドキュメントリーダーのビジョンを提示する。
既存の文書リーダーに追加するための18のNLP機能について説明するとともに,ユーザが閲覧体験をよりカスタマイズできる新しいプラグインマーケットプレースを提案する。
論文 参考訳（メタデータ） (2023-02-15T06:43:12Z) - Layout-Aware Information Extraction for Document-Grounded Dialogue:
Dataset, Method and Demonstration [75.47708732473586]
視覚的にリッチな文書から構造的知識と意味的知識の両方を抽出するためのレイアウト対応文書レベル情報抽出データセット(LIE)を提案する。
LIEには製品および公式文書の4,061ページから3つの抽出タスクの62kアノテーションが含まれている。
実験の結果、レイアウトはVRDベースの抽出に不可欠であることが示され、システムデモでは、抽出された知識が、ユーザが関心を持っている答えを見つけるのに役立つことも確認されている。
論文 参考訳（メタデータ） (2022-07-14T07:59:45Z) - FRUIT: Faithfully Reflecting Updated Information in Text [106.40177769765512]
FRUIT(FruIT)で更新情報を反映した新しい生成タスクについて紹介する。
我々の分析は、記事の更新が可能なモデルを開発するには、ニューラルジェネレーションモデルに新しい能力が必要であることを示している。
論文 参考訳（メタデータ） (2021-12-16T05:21:24Z)
関連論文リストは本サイト内にある論文のタイトル・アブストラクトから自動的に作成しています。
指定された論文の情報です。
本サイトの運営者は本サイト（すべての情報・翻訳含む）の品質を保証せず、本サイト（すべての情報・翻訳含む）を使用して発生したあらゆる結果について一切の責任を負いません。