このページでは、Google Season of Docs に承認された技術文書作成プロジェクトの詳細について説明します。
プロジェクトの概要
- オープンソース組織:
- CERN-HSF
- テクニカル ライター:
- LuckInTheRain
- プロジェクト名:
- ROOT ドキュメント: 分析、再構成、書き換え
- プロジェクトの長さ:
- 長時間実行（5 か月）
プロジェクトの説明
このプロジェクトは 4 つのフェーズで構成されています。
1）現在の ROOT ドキュメントの分析
ROOT ドキュメント全体（ウェブサイト、ユーザーガイド、C++ リファレンス、チュートリアルなど）が、構造化、モジュラー化、標準化、アクセス メカニズム、一貫性、使用される情報の種類、対象グループ固有の準備、理解可能性の基準に従って分析、チェックされます。情報管理のコンセプトと構造化マトリクス、コンテンツの標準化ガイドラインを作成することを目的としています。
2）ROOT チームと協力してソフトウェア ドキュメントの作成方法を定義する
ROOT チームには、ソフトウェア ドキュメントの OASIS 標準である DITA（Darwin Information Typing Architecture）（https://www.oasis-open.org/committees/dita/）が提示されます。主な内容は、ソフトウェア固有のコンテンツを構造化する方法と、ソフトウェア ドキュメントの作成に「コンセプト」、「タスク」、「リファレンス」などの基本的な情報タイプを使用する方法について理解することです。
3）ROOT ドキュメントの再編成
最初の 2 つのステップの結果に基づいて、ROOT ドキュメントがターゲットグループ、ロール、ユースケースに従って再構成され、モジュール化され、コンテンツが対応する要素（ウェブサイト、ユーザーガイド、C++リファレンス、チュートリアルなど）とコンテンツタイプに割り当てられます。利用可能な情報は非常に広範にわたるため、一貫した参照構造を確立する必要があります。目的は、包括的な概要を説明し、ユーザーのニーズに合わせて ROOT を使用する方法を明確に示すことです。また、物理学に偏らないコンパクトな概要も提供されています。
4）ROOT ドキュメントの書き換え
ドキュメントの主要部分（特にユーザーガイド）は、DITA アプローチに従って書き直されています。構成と記述のルールは、今後のドキュメントの一貫性を保つためにスタイルガイドに記録されます。目標は、将来 ROOT チームが自分たちで ROOT ドキュメントを拡張し、維持できるようにすることです。
推定スケジュール（5 か月）:
フェーズ 1: 現在の ROOT ドキュメントを分析する: 3 週間。
フェーズ 2: ROOT チームとソフトウェア ドキュメントの作成方法を定義する: 2 週間。
フェーズ 3: ROOT ドキュメントの再編成: 4 週間。
フェーズ 4: ROOT ドキュメントの書き換え: 11 週間