このページには、Google Season of Docs で承認されたテクニカル ライティング プロジェクトの詳細が掲載されています。
プロジェクトの概要
- オープンソースの組織:
- CERN-HSF
- テクニカル ライター:
- John
- プロジェクト名:
- CERN-HSF - 一般ユーザー向けの ROOT ドキュメント、動的 Python バインディング、チュートリアル
- プロジェクトの長さ:
- 長期実行（5 か月）
プロジェクトの説明
CERN-HSF - 一般ユーザー向けの ROOT ドキュメント、動的 Python バインディング、チュートリアル メンター: Olivier Couet、Axel Naumann
要約: ドキュメントはユーザーによるソフトウェア導入の成功と効率化に不可欠です。明確で正確かつ包括的なユーザー ドキュメントは、ユーザーが目標達成に向けてソフトウェアを習熟するのに役立ちます。また、明示的な例やチュートリアルは、ユーザーが迅速に学習するための強力なツールとなります。
物理学のデータ分析と可視化の分野で物理学者、研究者、デベロッパーが ROOT を使用する場合、ユーザー フレンドリーで最新のドキュメントのメリットが認識されています。特に、ソースコードの広範さとその成長により、ドキュメント システムを並行して進化させることで、ユーザーが ROOT が提供するすべての機能を最大限に活用できるようになります。
現在のドキュメントの概要と分析 現在、ユーザー ドキュメントには、物理学者が一般ユーザーよりも簡単に ROOT を採用できるようにするガイドが用意されています。また、動的 Python バインディングなどの特定のトピックでは、より包括的で明確なドキュメントにするために改善が加えられます。同様に、新しいデータ形式 RNTuple には、必要な詳細な仕様がありません。最後に、現在のドキュメントには ROOT 7 に関するチュートリアルがありません。
方法論: Olivier と協議した結果、前述の問題に対処するための主な焦点は、専門の研究者と一般読者との間の知識ギャップの特定、そのギャップを埋めるためのドキュメントの作成、ROOT 7 の「最新解析のためのチュートリアル」の実装、RNTuple の詳細な技術仕様の作成を行うことが主な対象でした。同様に、このプロセス中にドキュメントに Jupyter Notebook を組み込むことで、具体的でインタラクティブな学習ツールをユーザーに提供できます。
タイムライン: プロジェクトの段階は次のとおりです。 専門の研究者と一般ユーザーの間の知識のギャップを特定する（現在のドキュメントとソースコードを読む）→ 1 ～ 2 週間 ギャップを埋めるためのドキュメントを作成してリファクタリングする → 3 週間 Dynamic Python バインディングの詳細なドキュメントを作成する → 3 週間 Dynamic Python バインディングのチュートリアルを実装する → 3 週間 ROOT 7 のチュートリアルを実装する → 4 週間 RNTuple の詳細な技術仕様を作成する → 3 週間 プロジェクトの目的が正常に完了したことを確認する → 1 週間
成果物と成功のためのガイドライン: ギャップのない単一の統合ユーザー ドキュメント 最新の機能（新しい派生クラスなど）を反映するように完全に更新されたユーザー ドキュメント Jupyter ノートブックによるチュートリアル