このページには、Google シーズンのドキュメントで受け入れられているテクニカル ライティング プロジェクトの詳細が記載されています。
プロジェクトの概要
- オープンソースの組織:
- CERN-HSF
- テクニカル ライター:
- John
- プロジェクト名:
- CERN-HSF - 一般向け導入のための ROOT ドキュメント、動的 Python バインディング、チュートリアル
- プロジェクトの期間:
- 長時間（5 か月）
プロジェクトの説明
CERN-HSF - 一般向け導入のためのルート ドキュメント、動的 Python バインディング、チュートリアル メンター: Olivier Couet、Axel Naumann
要約: ユーザーによるソフトウェアの効果的な導入を成功させるには、ドキュメントが不可欠です。明確で正確、かつ包括的なユーザー ドキュメントにより、ソフトウェアの習熟度を向上させ、目標達成を目指せます。具体例やチュートリアルは、ユーザーがすばやく学習できるパワフルなツールです。
物理学のデータ分析と可視化の分野で物理学者、研究者、開発者による ROOT の使用について検討する中で、ユーザー フレンドリーで最新のドキュメントのメリットが注目されています。特に、ソースコードの幅広さとその成長により、ドキュメント システムは並列的に進化することのメリットを享受し、ROOT が提供するすべての機能を最大限に活用できるようにしています。
現在のドキュメントの要約と分析 現在、ユーザー ドキュメントには、物理学者が一般ユーザーよりも簡単に ROOT を導入するためのガイドが用意されています。さらに、動的 Python バインディングなどの特定のトピックでは、より包括的で明確なドキュメントに改善を加えることができます。同様に、新しいデータ形式 RNTuple には必要な詳細な仕様がありません。最後に、現在のドキュメントには ROOT 7 に関連するチュートリアルがありません。
方法論: Olivier と話し合った結果、専門研究者と一般ユーザーとの間の知識のギャップの特定、そのギャップを埋めるためのドキュメントの作成、動的 Python バインディングの詳細なドキュメントの作成、ROOT 7 の「最新の分析のためのチュートリアル」の実装、RNTuple の詳細な技術仕様の作成などに注力すべきだと考えました。また、このプロセス中に、具体的でインタラクティブな学習ツールがユーザーの役に立つように、ドキュメントに Jupyter ノートブックを組み込むこともできます。
タイムライン: プロジェクトの各段階の推定は次のとおりです。 専門研究者と一般ユーザーとの間の知識ギャップを特定する（現在のドキュメントとソースコードを読んでいる間）→ 1 ～ 2 週間 そのギャップを埋めるためのドキュメントの作成とリファクタリング → 3 週間 動的 Python バインディングの詳細なドキュメントの作成 → 3 週間 動的 Python バインディングのチュートリアルの実装 → 3 週間の技術的目標の作成 → 3 週間の技術的目標の作成 → ROOT の仕様の実装まで 3 週間
成果物と成功のためのガイドライン: 単一統一ユーザー ドキュメント（ギャップなし） ユーザー ドキュメントを完全に更新し、最新の機能（新しい派生クラスなど）を反映 Jupyter ノートブックによるチュートリアル