論文の概要: "A Second Set of Eyes": The Process and Challenges of Software Documentation Review
- arxiv url: http://arxiv.org/abs/2608.26232v1
- Date: Wed, 26 Aug 2026 17:28:36 GMT
- ステータス: 翻訳完了
- システム内更新日: 2026-08-28 16:30:58.130713
- Title: "A Second Set of Eyes": The Process and Challenges of Software Documentation Review
- Title（参考訳）: A Second Set of Eyes: the Process and Challenges of Software Documentation Review
- Abstract要約: ドキュメントレビュープロセスの5つの異なる段階を特定します。
本研究は,専門家レビュアーの募集において,作家が直面する組織的・技術的課題を明らかにするものである。
当社の作業は,ドキュメントレビューを,共同作業の重要かつ未検討の場として位置付けています。
- 参考スコア（独自算出の注目度）: 10.51106857366862
- License: http://creativecommons.org/licenses/by/4.0/
- Abstract: Organizations assign documentation work to technical writers, yet the knowledge required to produce it is distributed across developers, managers, and other practitioners. Prior work has established quality criteria for judging "good" documentation, but it has not examined how practitioners bring that expertise to improve documentation quality or the challenges they face in doing so. Through semi-structured interviews with experienced technical writers ($n=31$) from different organizations, our work reveals the individual and collaborative effort required to maintain documentation quality. We identify five distinct stages of the documentation review process: self review, technical review, editorial review, play testing, and post-publication feedback. Each stage draws on practitioners with distinct expertise to address quality across content, presentation, and user experience. Our findings surface organizational and technical challenges writers face in recruiting expert reviewers, navigating development timelines, and contending with tools not specifically designed for documentation workflows. Our work positions documentation review as a crucial yet understudied site of collaborative work and opens new research and design directions for process improvement and tool support.
- Abstract（参考訳）: 組織はドキュメントの作業をテクニカルライターに割り当てるが、作成に必要な知識は開発者、マネージャ、その他の実践者に分散している。
ドキュメントを判断するための品質基準を確立してきましたが、ドキュメントの品質改善や、それを行う上で直面する課題に対して、実践者がその専門知識をどのようにもたらすかは確認されていません。
さまざまな組織から経験豊富なテクニカルライター(31ドル)との半構造化されたインタビューを通じて、ドキュメントの品質を維持するのに必要な個人的かつ協力的な取り組みを明らかにします。
自己レビュー,技術レビュー,編集レビュー,プレイテスト,ポストパブリケーションフィードバックという,ドキュメントレビュープロセスの5つのステージを特定します。
各ステージは、コンテンツ、プレゼンテーション、ユーザーエクスペリエンスにまたがる品質に対処する専門知識を持つ実践者に焦点を当てます。
筆者らは、専門家レビュアーの募集、開発スケジュールのナビゲート、ドキュメントワークフローに特化して設計されたツールとの競合において、組織的および技術的な課題に直面している。
作業はドキュメントレビューを,共同作業の重要かつ未検討の場と位置づけ,プロセス改善とツールサポートのための新たな研究と設計の方向性を開く。
関連論文リスト
- DocClaw: A Unified Agentic System for Intelligent Document Processing [70.82545096015238]
本稿では,エージェントとドキュメント間のインタラクションの共有プロセスとして,多様なインテリジェントな文書処理タスクを定式化する統合エージェントシステムDocClawを紹介する。
この定式化の下で、タスク固有の要件は、エージェントのクエリ目的と対応するドキュメントスキルの解釈によってキャプチャされる。
複数のインテリジェントなドキュメント処理ベンチマークの実験では、DocClawが単一のエージェントフレームワーク内で、さまざまなタスクを効果的に処理していることが示されている。
論文 参考訳（メタデータ） (2026-08-19T08:34:48Z) - From Reflection to Repair: A Scoping Review of Dataset Documentation Tools [10.124271544484634]
59のデータセット文書出版物の混合メソッド分析によって支援された体系的レビューを提案する。
我々の分析では、データセットのドキュメント概念化において、採用と標準化を阻害する可能性のある4つの永続的なパターンが示されています。
これらの知見に基づいて,個別のソリューションではなく,機関的なAIツール設計へのシフトを提案する。
論文 参考訳（メタデータ） (2026-02-17T19:37:16Z) - DocReward: A Document Reward Model for Structuring and Stylizing [107.03974018371058]
DocRewardはドキュメントの構造とスタイルに基づいてドキュメントを評価するドキュメント報酬モデルである。
ブラッドリー・テリーの損失を利用して文書を採点し、注釈付きランキングに矛盾する予測を罰する訓練を受けている。
GPT-5の37.7%の勝利率に比べて60.8%の勝利率を達成した。
論文 参考訳（メタデータ） (2025-10-13T13:36:32Z) - The Software Documentor Mindset [10.55519622264761]
そこで、26人のボランティアドキュメンテーションコントリビュータ、すなわちドキュメンテーションコントリビュータにインタビューを行い、その理由と、それらのドキュメンテーションの作り方について聞いた。
ドキュメンテーションのコントリビューションプロセスにおいて,ドキュメンテーション担当者が持つ16の考察を,モチベーション,トピック選択技術,スタイリング目的の3つの側面に沿って特定した。
本稿では,ドキュメントのコントリビューションプロセスに関する推論の枠組みとして,考え方の構造とその3つの側面にわたる考察を提案する。
論文 参考訳（メタデータ） (2024-12-12T16:28:08Z) - 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) - Systematic Mapping Protocol -- UX Design role in software development
process [55.2480439325792]
ソフトウェア開発プロセスにおけるUXデザイナの役割を調べるための体系的なマッピングプロトコルを提案する。
本研究は,地図作成に使用する研究課題,スコープ,ソース,検索戦略,選択基準,データ抽出,分析方法を定義する。
論文 参考訳（メタデータ） (2024-02-20T16:56:46Z) - Functional Analytics for Document Ordering for Curriculum Development
and Comprehension [0.0]
本稿では,カリキュラム開発のための自動文書注文生成手法と,学習,トレーニング,その他のコンテンツシーケンスアプリケーションに使用する最適な読解順序作成手法を提案する。
このようなテクニックは、理解力の向上、説明が必要な領域の特定、カリキュラムの生成、検索結果の改善に使用することができる。
論文 参考訳（メタデータ） (2023-11-22T02:13:27Z) - Understanding Documentation Use Through Log Analysis: An Exploratory
Case Study of Four Cloud Services [14.104545948572836]
クラウドベースの4つの産業サービスから,ドキュメントのページビューログを分析した。
10万人以上のユーザのページビューログを分析することで、さまざまなドキュメントページ訪問パターンが見つかる。
本論文では,文書の監査を行うための有効な手法として,文書のページビューログ分析を提案する。
論文 参考訳（メタデータ） (2023-10-16T20:37:29Z) - DocTER: Evaluating Document-based Knowledge Editing [53.14000724633775]
本稿では,手作業で3つの文書をラベル付けするのではなく,簡単にアクセスできる文書を用いた知識編集について検討する。
総合的な4つのパースペクティブ評価: 編集成功、局所性、推論、言語間移動。
一般的な知識編集手法の実験は、文書による編集が三重項を使用するよりもはるかに大きな課題を示すことを示した。
論文 参考訳（メタデータ） (2023-08-19T09:17:19Z) - A Survey of Deep Learning Approaches for OCR and Document Understanding [68.65995739708525]
我々は、英語で書かれた文書の文書理解のための様々な手法をレビューする。
文献に現れる方法論を集約し,この領域を探索する研究者の跳躍点として機能させる。
論文 参考訳（メタデータ） (2020-11-27T03:05:59Z) - Documentation of Machine Learning Software [7.154621689269006]
機械学習ソフトウェアドキュメンテーションは、ソフトウェア工学の研究で研究されたほとんどのドキュメントとは異なる。
私たちの最終的な目標は、さまざまなレベルの専門知識を持つユーザのための機械学習ソフトウェアドキュメントの自動生成と適応です。
Stack Overflow Q/Aを調査し、機械学習領域内のドキュメント関連Q/Aを分類する。
論文 参考訳（メタデータ） (2020-01-30T00:01:28Z)
関連論文リストは本サイト内にある論文のタイトル・アブストラクトから自動的に作成しています。
指定された論文の情報です。
本サイトの運営者は本サイト（すべての情報・翻訳含む）の品質を保証せず、本サイト（すべての情報・翻訳含む）を使用して発生したあらゆる結果について一切の責任を負いません。