このページでは、Google Season of Docs に承認された技術文書作成プロジェクトの詳細について説明します。
プロジェクトの概要
- オープンソース組織:
- LibreOffice
- テクニカル ライター:
- クレジアロ
- プロジェクト名:
- 計算関数のリファレンスとユーザーガイド
- プロジェクト期間:
- 標準期間（3 か月）
プロジェクトの説明
プロジェクト リクエスト
技術的な文章作成の段階では週に 30 ～ 35 時間、執筆前の段階では 10 ～ 12 時間、プロジェクトに必要な追加スキルを習得するために簡単に時間を割くことができます。現在、私は大学（母国）に住んでおり、高速インターネットとプロジェクトに必要なアドオン リソースにアクセスできます。プロジェクトの期間中は大学から引き続き勤務します。現在、COVID-19 の状況にあり、大学がすぐに再開されるとは思えません。再開されたとしても、私は最終学年で、週に 5 ～ 6 時間しか授業に出席しないため、プロジェクトに影響することはありません。
はじめに
LibreOffice Calc には、多くのカテゴリにわたる 500 を超える関数のリストがありますが、ヘルプにはこれらの関数に関する詳細な説明はありません（ただし、正確です）。Calc の組み込み関数ウィザードでは、各関数の目的とパラメータに関する概要情報を確認できます。The Document Foundation のウィキに、Calc の関数に関する詳細なリファレンス情報をまとめた構造が作成されました。
目的
Calc の関数ごとに詳細な内容を記述してウィキ構造に入力するには、イラストや図を含む ODFF 標準への準拠を明記し、コーナーケースと例外を示す 1 ～ 2 つの例を挙げ、サンプル ファイルや例を提供すると役立ちます。
プロジェクト作業計画
私はプロジェクトの核となる考えを徹底的に理解しました。基本的には、関数ウィザードの各関数の動作を文書化し、各関数のすべての側面をカバーする十分な例とともに、新しいユーザーが検索して数秒でその使用方法を理解できるように、可能な限り直感的な文書を作成しようとしています。
これらの機能をカテゴリ別に分類することをおすすめします。
• Database: This section deals with functions used with data organized as one row of data for one record.
• Date & Time: These spreadsheet functions are used for inserting and editing dates and times.
• Financial: This category contains the mathematical finance functions of LibreOffice Calc.
• Information: This category contains Information functions.
• Logical: This category contains Logical functions.
• Mathematical: This category contains the Mathematical functions for Calc.
• Array: This category contains the array functions.
• Statistical: This category contains Statistics functions.
• Spreadsheet: This section contains descriptions of the Spreadsheet functions together with an example.
• Text: This section contains descriptions of the Text functions.
• Add-in: The following describes and lists some of the available add-in functions.
各カテゴリには 20 ～ 50 個程度の機能があり、それ以上の機能を持つカテゴリはほとんどありません。ほとんどの説明には、構文と 1 つの例が含まれます。
Calc の関数ごとに、より詳細な内容を追加し、ODFF 標準に準拠していることを明記し、必要に応じて図や図表を追加し、コーナーケースや例外をメモの形で 1 ～ 2 つ示し、サンプル ファイルも提供します。また、必要に応じて「重要」セクションを追加します。これらの機能は、カテゴリ形式で説明することを検討しています。つまり、1 つの機能を取り上げて縦方向に作業し、技術的な記述期間中に別のカテゴリに移行します。また、コミュニティ ボンディング期間中に職場環境に慣れ、執筆フェーズをスムーズに進めることをおすすめします。私の経験上、このようなタイプのアプリケーションをドキュメント化する場合、小さな「落とし穴」をすべて見つけるには時間が必要です。計画的には、最初にこれらの 11 の項目をすべて確認して、プロジェクトに取り組みます。もちろん、一部の項目は他の項目よりも多くの支援が必要で、時間もかかりますが、これらの問題は作業中に対処できます。すでにドキュメントが存在し、その上に記述しているため、最終週まで残すのは良くないので、各週のタスクが完了した後に校正することを検討します。
以下に、制限時間内にプロジェクトをまとめるための大まかなスケジュールを示します。
- 1 週目:（9 月 14 日） • データベース
- 第 2 週:（9 月 21 日） • 日時
- 第 3 週:（9 月 28 日） • 財務
- 第 4 週:（10 月 5 日） • 情報
- 第 5 週:（10 月 12 日） • 論理
- 第 6 週:（10 月 19 日） • 数学
- 第 7 週:（10 月 26 日） • 配列
- 第 8 週:（11 月 2 日） • 統計
- 第 9 週:（11 月 9 日） • スプレッドシート
- 第 10 週:（11 月 16 日） • テキスト
- 11 週目:（11 月 23 日） • アドイン
- 第 12 週:（11 月 30 日～ 12 月 5 日）（最終週）
このプロジェクトで行った作業と得た経験を文書化し、ドキュメントを送信できるようにするために、必要に応じて 2 回目の校正/編集などの細かい作業を行います。