[論文レビュー] You Only Write Thrice: Creating Documents, Computational Notebooks and Presentations From a Single Source

Kacper Sokol, Peter Flach|arXiv (Cornell University)|Jul 2, 2021

Digital Humanities and Scholarship参考文献 1被引用数 4

ひとこと要約

この論文は、バージョン管理されたマークダウンファイルを用いて、1つのソースから学術文書、計算ノートブック、プレゼンテーションを統合的に生成するワークフローを提案する。Gitベースのシステム内でJupyter Book、Jupyter Notebooks、reveal.jsを活用することで、エンドツーエンドのバージョン管理とレビュー支援を備えた再現可能でインタラクティブで透明性のある学術的コミュニケーションを実現する。

ABSTRACT

Academic trade requires juggling multiple variants of the same content published in different formats: manuscripts, presentations, posters and computational notebooks. The need to track versions to accommodate for the write--review--rebut--revise life-cycle adds another layer of complexity. We propose to significantly reduce this burden by maintaining a single source document in a version-controlled environment (such as git), adding functionality to generate a collection of output formats popular in academia. To this end, we utilise various open-source tools from the Jupyter scientific computing ecosystem and operationalise selected software engineering concepts. We offer a proof-of-concept workflow that composes Jupyter Book (an online document), Jupyter Notebook (a computational narrative) and reveal.js slides from a single markdown source file. Hosted on GitHub, our approach supports change tracking and versioning, as well as a transparent review process based on the underlying code issue management infrastructure. An exhibit of our workflow can be previewed at https://so-cool.github.io/you-only-write-thrice/.

研究の動機と目的

• 論文、プレゼンテーション、ノートブック、ポスターといった学術的出力の断片化を解消し、保守が難しく整合性を保てない複数のバージョン管理形式に分かれている状態を是正すること。
• 複数の形式にわたりコンテンツの作成と改訂を行う負担を軽減するため、それらを1つのソースに統合すること。
• バージョン管理やイシューベースレビューといったソフトウェア工学的手法を採用することで、学術的出版における透明性と履歴追跡性を向上させること。
• Jupyterエコシステムのオープンソースツールを活用して、インタラクティブで実行可能でアクセス可能な学術的出力を実現すること。
• GitHubなどのプラットフォームにコンテンツをホスティングし、統合されたレビューワークフローを備えることで、持続可能で再利用可能でコミュニティ主導の学術的コミュニケーションを支援すること。

提案手法

• すべてのコンテンツの唯一の真実のソースとして、拡張されたマークダウン（MySTフォーマット）を使用すること。
• 同じソースからJupyter Bookベースのドキュメントを生成し、インタラクティブで実行可能なウェブベースの原稿を生成すること。
• 同じソースからJupyter Notebooksを生成し、計算の再現性とライブコーディングを支援すること。
• 同じソースからreveal.jsベースのスライドデッキを生成し、ダイナミックでインタラクティブなプレゼンテーションを提供すること。
• ソースをGitHubにホスティングし、バージョン管理とイシュー追跡を活用することで、透明性がありコードに似たレビュープロセスを可能にすること。
• Jupyter Book、Jupyter、reveal.jsといったオープンソースツールを活用することで、アクセシビリティ、インタラクティビティ、デバイスおよびプラットフォーム間の互換性を確保すること。

実験結果

リサーチクエスチョン

• RQ1 1つのソースドキュメントを用いて、重複や不整合を生じさせることなく、論文、ノートブック、プレゼンテーションの複数の学術的出力形式を生成できるか？
• RQ2 ソフトウェア工学におけるバージョン管理とイシュー追跡の手法を、学術的出版における透明性と追跡可能性の向上にどう適応できるか？
• RQ3 インタラクティブで実行可能なコンテンツを学術的出力に統合する際、アクセシビリティと長期的な持続可能性を保つにはどの程度まで可能か？
• RQ4 従来のPDF中心のワークフローから、動的でウェブネイティブなパブリッシングモデルに置き換える際の実務的課題は何か？
• RQ5 GitHubのようなコミュニティ主導のプラットフォームは、コード共有にとどまらず、学術的コンテンツの作成、レビュー、配布をどのように支援できるか？

主な発見

• 提案されたワークフローは、オープンソースツールを用いて、1つのマークダウンソースファイルから、ドキュメント、計算ノートブック、プレゼンテーションという3つの異なる学術的出力を成功裏に生成した。
• Gitベースのバージョン管理の活用により、変更履歴の完全な追跡が可能となり、ソフトウェア開発と同様の透明性があり監査可能な出版ライフサイクルをサポートした。
• 実行可能なコードブロックやダイナミックな可視化といったインタラクティブコンテンツが、生成された出力にネイティブにサポートされており、再現性と関与度が向上した。
• ウェブ標準準拠とアクセシビリティ支援技術（スクリーンリーダーやナビゲーションアシスト）との統合により、アクセシビリティが維持された。
• 静的HTML、PDF、EPUBのエクスポートにより、オンラインアクセスとオフラインブラウジングの両方が可能となり、デバイスやプラットフォームを問わず広範なアクセシビリティを確保した。
• 本アプローチの実現可能性は、https://so-cool.github.io/you-only-write-thrice/ に公開された、実証的プロトタイプを通じて裏付けられた。このプロトタイプは、パイプライン全体を実際に動作させたものである。