論文の概要: "Add more config detail": A Taxonomy of Installation Instruction Changes
- arxiv url: http://arxiv.org/abs/2312.03250v1
- Date: Wed, 6 Dec 2023 02:54:26 GMT
- ステータス: 処理完了
- システム内更新日: 2023-12-07 16:19:00.081649
- Title: "Add more config detail": A Taxonomy of Installation Instruction Changes
- Title(参考訳): 「より詳細な設定」:インストール指示の変更の分類
- Authors: Haoyu Gao, Christoph Treude, Mansooreh Zahedi
- Abstract要約: 私たちは、インストール関連セクションのアップデートに焦点を当てた1,163のコミットで、400のGitHubリポジトリを調査しました。
調査の結果,コミットの変更には,プリインストール命令,インストール後のインストレーション命令,ドキュメント提示,外部リソース管理の6つの大きなカテゴリが明らかになった。
本研究の成果から,ファイルの保存や今後の研究方向性のモチベーションについて,実践者に推奨する。
- 参考スコア(独自算出の注目度): 11.219774223416648
- 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 provide recommendations to practitioners for
maintaining their README files, as well as motivations for future research
directions. These recommendations and research directions encompass
completeness, correctness and up-to-dateness, and information presentation
consideration. The proposed research directions span the development of
automated documentation tools and empirical studies to enhance comprehension of
the needs of documentation users. Furthermore, we provide a comprehensive
README template tailored to cover the installation-related sections for
document maintainers, serving as a practical starting point for their efforts.
- Abstract(参考訳): READMEファイルはソフトウェアユーザーにインストール関連の指示を提供する上で重要な役割を果たし、GitHubなどのプラットフォーム上のオープンソースソフトウェアシステムで広く利用されている。
しかし、これらのファイルは、しばしば様々なドキュメントの問題に悩まされ、コンテンツの理解と潜在的なエラーを引き起こす。
その重要性にもかかわらず、READMEファイル、特にユーザーがソフトウェアプロジェクトを始めるのに不可欠であるインストール関連命令の文脈において、READMEファイルに費やされたドキュメントの取り組みに関する体系的な理解が欠如している。
調査ギャップを埋めるため,400のgithubリポジトリを対象に,インストール関連の更新に注目した1,163のreadmeコミットによる質的研究を実施した。
本研究は,READMEコミットの変更点として,プリインストール指示,インストール指示,ポストインストール指示,ヘルプ情報更新,ドキュメント提示,外部リソース管理の6つのカテゴリを明らかにした。
さらに、修正行動に関する詳細な洞察を提供し、これらの更新の例を示します。
本研究は,READMEファイルの保存と今後の研究方向性のモチベーションについて,実践者に推奨するものである。
これらの勧告と研究の方向性は、完全性、正確性、最新性、情報提示の考慮を含む。
提案する研究の方向性は,ドキュメント利用者のニーズの理解を深めるための,自動文書作成ツールや実証研究の開発にまたがる。
さらに,ドキュメントメンテナのインストール関連セクションをカバーするために調整された包括的なreadmeテンプレートを提供し,その取り組みの出発点として活用する。
関連論文リスト
- InstructDoc: A Dataset for Zero-Shot Generalization of Visual Document
Understanding with Instructions [30.609533589284634]
InstructDocは、30の一般公開されたビジュアルドキュメント理解データセットの大規模なコレクションである。
InstructDrは、トレーニング可能なブリッジモジュールを通じて、ドキュメントイメージ、イメージエンコーダ、および大きな言語モデル(LLM)を接続する。
実験では、InstructDrが与えられた命令を介して、新しいVDUデータセット、タスク、ドメインに効果的に適応できることが示されている。
論文 参考訳(メタデータ) (2024-01-24T09:09:37Z) - Using an LLM to Help With Code Understanding [13.53616539787915]
大規模言語モデル(LLM)は、コードを書くプロセスに革命をもたらしています。
プラグインはOpenAIのGPT-3.5-turboモデルに対して,ユーザが明示的なプロンプトを書かなくても4つの高レベルリクエストをクエリする。
本システムの評価は,32名の被験者を対象に行ったユーザスタディで行われ,本プラグインがWeb検索よりもタスク完了に有効であることが確認された。
論文 参考訳(メタデータ) (2023-07-17T00:49:06Z) - mPLUG-DocOwl: Modularized Multimodal Large Language Model for Document
Understanding [55.4806974284156]
文書理解とは、ウェブページのようなデジタル文書から自動的に情報を抽出し、分析し、理解することである。
既存のMLLM(Multi-model Large Language Models)は、浅いOCRフリーテキスト認識において、望ましくないゼロショット機能を実証している。
論文 参考訳(メタデータ) (2023-07-04T11:28:07Z) - Task-aware Retrieval with Instructions [91.87694020194316]
そこで本研究では,検索システムのユーザがクエリとともに意図を明示的に記述する,命令による検索の問題について検討する。
本稿では,多様な検索タスクを指示で訓練したマルチタスク検索システムTARTを提案する。
TARTは命令を通じて新しいタスクに適応する強力な能力を示し、2つのゼロショット検索ベンチマークでテクニックの状態を向上する。
論文 参考訳(メタデータ) (2022-11-16T23:13:22Z) - FETA: Towards Specializing Foundation Models for Expert Task
Applications [49.57393504125937]
ファンデーションモデル(FM)は、ゼロショット学習、高忠実度データ合成、ドメインの一般化など、前例のない機能を示した。
この論文では、FMは、まだ専門家のタスクにおいて、出来の悪いパフォーマンスを保っていることを示します。
本稿では,FMに技術資料の理解を促すことを目的として,その第1のFETAベンチマークを提案する。
論文 参考訳(メタデータ) (2022-09-08T08:47:57Z) - 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) - Unified Pretraining Framework for Document Understanding [52.224359498792836]
文書理解のための統合事前学習フレームワークであるUDocを紹介する。
UDocは、ほとんどのドキュメント理解タスクをサポートするように設計されており、Transformerを拡張してマルチモーダル埋め込みを入力とする。
UDocの重要な特徴は、3つの自己管理的損失を利用して汎用的な表現を学ぶことである。
論文 参考訳(メタデータ) (2022-04-22T21:47:04Z) - CSSR: A Context-Aware Sequential Software Service Recommendation Model [4.306391411024746]
ユーザが適切なリポジトリをGitHubで見つけるのに役立つ新しいソフトウェアサービスレコメンデーションモデルを提案する。
我々のモデルはまず,リポジトリのリッチなコンテキスト情報を活用するために,新しいコンテキスト依存のリポジトリグラフ埋め込み法を設計する。
そして、ソフトウェアサービスレコメンデーション分野において、初めてユーザー-リポジトリ間のインタラクションのシーケンス情報を活用する。
論文 参考訳(メタデータ) (2021-12-20T03:17:42Z) - A Mining Software Repository Extended Cookbook: Lessons learned from a
literature review [1.5293427903448022]
Mining Software Repositories(MSR)の主な目的は、最新の拡張を発見し、ソフトウェアプロジェクトを改善する方法についての洞察を提供することである。
本稿では,MSR クックブックの MSR の知見を更新し,まず,最先端のクックブックを抽出・解析し,拡張したバージョンのクックブックを提案する。
この拡張されたクックブックは、4つの高いレベルのテーマに基づいて構築され、112の選ばれた研究のリストの分析から導かれた。
論文 参考訳(メタデータ) (2021-10-08T12:49:09Z) - An Overview of Recommender Systems and Machine Learning in Feature
Modeling and Configuration [55.67505546330206]
レコメンダーシステムおよび機械学習技術の適用に関連する潜在的な新しい研究ラインの概要を説明します。
本論文では,レコメンダーシステムと機械学習の応用例を示し,今後の研究課題について考察する。
論文 参考訳(メタデータ) (2021-02-12T17:21:36Z) - Documentation of Machine Learning Software [7.154621689269006]
機械学習ソフトウェアドキュメンテーションは、ソフトウェア工学の研究で研究されたほとんどのドキュメントとは異なる。
私たちの最終的な目標は、さまざまなレベルの専門知識を持つユーザのための機械学習ソフトウェアドキュメントの自動生成と適応です。
Stack Overflow Q/Aを調査し、機械学習領域内のドキュメント関連Q/Aを分類する。
論文 参考訳(メタデータ) (2020-01-30T00:01:28Z)
関連論文リストは本サイト内にある論文のタイトル・アブストラクトから自動的に作成しています。
指定された論文の情報です。
本サイトの運営者は本サイト(すべての情報・翻訳含む)の品質を保証せず、本サイト(すべての情報・翻訳含む)を使用して発生したあらゆる結果について一切の責任を負いません。