このページには、Google シーズンのドキュメントで受け入れられているテクニカル ライティング プロジェクトの詳細が記載されています。
プロジェクトの概要
- オープンソースの組織:
- CERN-HSF
- テクニカル ライター:
- LuckInTheRain
- プロジェクト名:
- ROOT ドキュメント: 分析、再構成、書き換え
- プロジェクトの期間:
- 長時間（5 か月）
プロジェクトの説明
このプロジェクトは、次の 4 つのフェーズで構成されています。
1）現在の ROOT ドキュメントの分析
ルート ドキュメント全体（ウェブサイト、ユーザーガイド、C++ リファレンス、チュートリアルなど）は、構造化、モジュール化、標準化、アクセス メカニズム、一貫性、使用する情報タイプ、ターゲット グループ固有の準備、わかりやすさという基準に従って分析およびチェックされます。目的は、情報管理のコンセプトと、構成のマトリックスおよびコンテンツを標準化するためのガイドラインを作成することです。
2）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: ルート ドキュメントの書き換え: 11 週間