このページには、Google Season of Docs で承認されたテクニカル ライティング プロジェクトの詳細が掲載されています。
プロジェクトの概要
- オープンソース組織:
- LibreOffice
- テクニカル ライター:
- quaffeine
- プロジェクト名:
- LibreOffice Online ガイド: 他の LO アプリケーションで使用されているガイドに似ており、使用方法だけでなく、インストールと管理も説明しています。
- プロジェクト期間:
- 標準の期間（3 か月）
プロジェクトの説明
もし選ばれた場合、週に 8 ～ 10 時間を費やして、新しいコンテンツの執筆と、既存のガイド コンテンツの修正と再利用の両方を行い、LibreOffice Online（LOOL）ガイドを作成する予定です。普段は週に 8 時間から 10 時間、執筆に費やすペースで、約 200 ページ以上の長さのガイドを制作するでしょう。
私は StarOffice の時代からこれらのアプリケーションを使用していて、デスクトップ バージョンの高度な機能（以下に例を示します）を熟知しています。
- アプリケーション全体のスタイル
- Writer のマスター ドキュメント、相互参照、図、デスクトップ パブリッシングのコンセプト
- Calc のグラフ、グラフ、データ分析ツール
- Impress のインタラクティブなプレゼンテーション機能（遷移やアニメーションなど）
私は、これらのパソコン版を仕事とプライベートの両方で幅広く使用しています。
このガイドは、技術的な知識が中程度のユーザーを対象としています。このようなユーザーは、スキル、忍耐力、そして何よりも LOOL のセットアップと運用に興味を持っている可能性が高いためです。リファレンスとして、もちろんわかりやすい説明コンテンツ（テキスト選択を太字にする方法など）が含まれますが、一部の技術的なコンセプト（ウェブサーバーがブラウザにアプリケーションを提供する責任を負っていることなど）の理解が前提となります。
計画面では、最初は以下のスケジュールに沿ってプロジェクトに取り組みます。注: 各章の作成順序は、最終的なガイドでの位置を示すものではありません。
1 週目: インストール手順の確認、さまざまなインストール方法のテスト、アプリの確認
今週の目標は、LOOL を正常にインストールすることです。私の経験上、このようなタイプのアプリケーションをドキュメント化する場合、小さな「落とし穴」をすべて見つけるには時間が必要です。今週は、これらの障害に引っかかることなく、利用可能な方法でアプリケーションを簡単にインストールできる状態になるまで、これらの問題を解決したいと思います。
2 週目: 参照インストールを実施し、インストール方法を記録する
この週は、インストール手順の簡単なリスト（完全に書式設定されたものではなく、「手順」に沿ったもの）と、後半の章に含めるいくつかのメモをまとめます。
3 週目: 序章の章（前書き、はじめに、このガイドについてなど）を作成します。
この週の目標は、実際の取り付けを行う前に読者が必要とする関連情報をすべて含む、1 つ以上の完成した章を仕上げることです。
第 4 週: インストール チャプターを記述する（パート 1）
この週の目標は、利用可能な方法の一部について、標準の LibreOffice ガイドの章形式で、インストール手順を完成させ、洗練させることです。ただし、ウィキなど、他の用途に簡単に再利用できる形式にします。
第 5 週: インストールに関する章を作成する（パート 2）
今週の目標は、残りのメソッドについて、標準の LibreOffice Guide のチャプター形式で、簡単に再利用できる形式（Wiki など）で、残りのメソッドのインストール手順を洗練させることです。
週 6: インストール後の構成に関する章を書く
今週の目標は、インストール後の構成に関する章を完成させ、磨きをかけることを目指します。具体的には、アプリケーションの設定（タイムゾーンなど）、ユーザーの設定、システムを本番環境に移行する前に管理者が行うその他の準備などです。
第 7 週: ナビゲーション、インターフェース、ファイル管理の章を記述する
この週の目標は、読者が UI を使いこなせるよう、章を完成させ、磨き上げることです。
第 8 週: Write Writer（ワープロ）のチャプター
今週は、ユーザーがアプリ内で美しいスタイルのドキュメントを直接作成できるように、完成した洗練されたチャプターが提供される予定です。
週 9: 計算（スプレッドシート）の章を作成する
今週の目標は、サポートされている数式やグラフ/グラフの選択など、ユーザーが実用的なスプレッドシートを作成できるように、完璧で洗練された章を提供することです。
10 週目: Impress（プレゼンテーション）のチャプターを作成する
この週の目標は、ユーザーがインタラクティブなプレゼンテーションを作成して、オフラインでの視聴やライブ プレゼンテーション用に出力できるように、章を完成させ、磨き上げることです。
第 11 週: 統合のチャプターの作成
11 週目の目標は、利用可能な統合オプションの全体像をユーザーに提供できる、完成度の高い章を作成することです。アプリを統合するための具体的なガイダンスは、多くの場合、Document Foundation の Wiki ページや統合プロジェクトなど、関連リソースへのリンクの形になります。
週 12: その他の項目（付録、索引、図表目録など）をまとめ、1 回目の編集/校正
今週末には、最終的なコンテンツに近い内容と、相互参照などの完全な要素を含む完全なガイドが完成する予定です。
週 13: 2 回目の編集/校正、組版/レイアウトの確認、送信
今週の最終週には、コンテンツとプレゼンテーションの両方を編集した、完成品のガイドが提出されます。