このページには、参加が承認されたテクニカル ライティング プロジェクトの詳細が掲載されています 「Google Season of Docs」です。
プロジェクトの概要
- オープンソースの組織:
- LibreOffice
- テクニカル ライター:
- Krezhairo
- プロジェクト名:
- Calc 関数リファレンスとユーザーガイド
- プロジェクト期間:
- 標準の期間（3 か月）
プロジェクトの説明
プロジェクト リクエスト
プロジェクトに必要なスキルの追加を学ぶには、テクニカル ライティング フェーズでは週に 30 ～ 35 時間、プレライティング フェーズでは 10 ～ 12 時間を簡単に費やすことができます。現在、私は（母国）の大学に住んでいて、高速インターネットとプロジェクトに必要なアドオン リソースにアクセスできます。COVID-19 の状況下でプロジェクト期間全体は大学自体で活動を続けます。 たとえ大学が始動する予定はないのですが、たとえそれが始まったとしても、週に 5 ～ 6 時間しか授業に出席できない最終年度なので、プロジェクトにはまったく影響しません。
はじめに
LibreOffice Calc には、多くのカテゴリで広範な（+ 500）関数のリストがありますが、ヘルプではドキュメントがかなり浅い（ただしそれにもかかわらず正確）です。Calc に組み込まれている関数ウィザードでは、各関数の目的とパラメータに関する要約情報も表示されます。Calc の関数に関するより詳細な参照情報を取得するために、Document Foundation の Wiki に構造が作成されました。
目的
Calc の各関数について、より詳細な内容を記述して Wiki の構造を完成させるために、イラストや図を含む 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 週間にとどめるのは適切ではありません。
以下に、制限時間内にプロジェクトをまとめるための大まかなスケジュールを示します。
- 第 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 次パスの校正/編集を含めました。