このページには、Google シーズンの Google ドキュメントで承認されたテクニカル ライティング プロジェクトの詳細が記載されています。
プロジェクトの概要
- オープンソースの組織:
- LibreOffice
- テクニカル ライター:
- quaffeine
- プロジェクト名:
- LibreOffice オンライン ガイド: 他の LO アプリケーションで使用されるものと同様のガイドで、使用方法だけでなくインストールと管理についても記載されています。
- プロジェクトの期間:
- 標準の長さ(3 か月)
プロジェクトの説明
選ばれた場合、LibreOffice Online(LOOL)ガイドの作成に、週に 8 ~ 10 時間を費やして新しいコンテンツを作成するだけでなく、既存の Guide コンテンツを変更して再利用することを計画しています。通常、週に 8 時間から 10 時間の時間をかけて執筆しているので、ガイドは 200 ページ以上の長さになると思います。
私は StarOffice になってからこれらのアプリケーションを使用しており、次のようなデスクトップ版の高度な機能についても熟知しています。
- アプリケーション全体でのスタイル
- Writer のドキュメント、相互参照、図、デスクトップ パブリッシングのコンセプトのマスター
- Calc のチャート、グラフ、データ分析ツール
- Impress のトランジションやアニメーションなどのインタラクティブなプレゼンテーション機能
パソコン版は仕事でもプライベートでも幅広く使用しています。
このガイドの対象は、中級技術系のユーザーです。これらのユーザーは、LOOL のようなものを導入して実行することにスキルと忍耐力があり、最も重要なことに関心を持つ可能性が高いです。リファレンスという意味では、わかりやすい説明的なコンテンツ(テキストを太字にする方法など)が含まれていることは言うまでもありませんが、一部の技術的概念(つまり、ウェブ サーバーがブラウザにアプリケーションを提供する役割を担っている)を理解していることを前提としています。
まずは、下記のスケジュールに沿ってプロジェクトに取り組みます。注: 各章の記述順序は、必ずしも最終ガイドでの位置を示すものではありません。
1 週目: インストール手順の確認、さまざまなインストール方法のテスト、アプリケーションの探索
今週の目標は、LOOL を実際にインストールすることです。私の経験上、このようなアプリケーションを文書化するちょっとした「落とし穴」の瞬間をすべて発見するには、時間の投資が必要です。今週中に、このような障害に悩まされることなく、利用可能な方法でアプリケーションを簡単にインストールできるところまで、検討していきたいと考えています。
第 2 週: リファレンス インストールの実行、インストール方法に関するドキュメント
今週は、インストール手順の大まかなリスト(完全に記述された形式ではなく、数値で示したもの)と、後の章で追加するいくつかの注意事項をまとめます。
第 3 週:序文のチャプターを書く - 前書き、はじめに、このガイドについてなど
今週の目標は、実際のインストールに着手する前に、読者が必要な情報をすべて含む洗練された章を 1 つ以上作成することです。
第 4 週: インストール チャプターの作成、パート 1
今週の目標は、利用可能ないくつかのメソッドの完全で洗練されたインストール手順です。標準の LibreOffice Guide のチャプター形式に加え、Wiki などで簡単に再利用できる形式にします。
第 5 週: インストール チャプターの作成、パート 2
今週の目標は、残りのメソッドのインストール手順を、標準的な LibreOffice Guide のチャプター形式に加え、Wiki などで簡単に再利用できる形式にすることです。
第 6 週: インストール後の構成の書き込み
今週の目標は、アプリケーションの設定(タイムゾーンなど)の設定、ユーザーの設定、システムを本番環境に移行する前に管理者が行うその他の準備など、インストール後の構成に関する完成度の高い洗練された章です。
第 7 週: ナビゲーション、インターフェース、ファイル管理の章を記述する
今週の目標は、一読すれば、UI の操作に慣れ親しんでいただける、完成された洗練された章です。
第 8 週:書き込みライター(ワードプロセッシング)章
今週は、完成された洗練されたチャプターが登場します。ユーザーはこの章で、スタイルが優れたドキュメントをアプリで直接作成できます。
第 9 週: 計算(スプレッドシート)チャプターの書き込み
今週の目標は、サポートされる数式、チャート/グラフの選択など、実用的なスプレッドシートをユーザーが作成するための完成で洗練された章を作成することです。
第 10 週: インプレッション(プレゼンテーション)チャプターの作成
今週の目標は、完成された洗練されたチャプターです。ユーザーはこの章で、オフライン利用やライブ プレゼンテーション用に出力できるインタラクティブなプレゼンテーションを作成できます。
第 11 週: 統合チャプターの書き込み
第 11 週の目標は完成された洗練された章で、利用可能な統合オプションの全体像をユーザーに提供します。アプリケーションを統合するための具体的なガイダンスは、Document Foundation の Wiki ページや統合プロジェクトなど、関連リソースへのリンクという形になります。
12 週目:雑貨(付録、インデックス、数値表など)の組み立て初回パスの編集/校正
今週の最後に、ほぼ最終的なコンテンツと、相互参照などの無傷で機能する要素を含む完全ガイドが用意されます。
13 週目: 2 回目のパスの編集/校正、タイプセット/レイアウトの確認、送信
この最後の週には、コンテンツとプレゼンテーションの両方を編集した最終版ガイドが提出されます。