LibreOffice 專案

本頁針對 Google 系列文件接受的技術撰寫專案提供詳細資料。

專案摘要

開放原始碼機構:
LibreOffice
技術文件撰寫者:
克雷扎羅
專案名稱:
Calc 函式參考資料和使用手冊
專案長度:
標準長度 (3 個月)

Project description

專案要求

在技術寫作階段中,我可以輕鬆安排每週 30 到 35 小時的作業,並在預先寫作階段的 10 到 12 小時,逐步瞭解如何增加專案所需的技能。我想告訴你,目前住在我的大學(就居住國家/地區) 可以快速使用網際網路,以及任何專案所需的附加資源。由於 COVID-19 疫情,我很快就看不到大學,因此,即使在最後一年內,我應該不到 6 小時就上課了。

簡介

LibreOffice Calc 有大量函式類別 (超過 500 個) ,而「說明」中的說明文件相當精簡 (但絕不會很準確)。Calc 內建的函式精靈還會向使用者提供每個函式用途和參數的摘要資訊。我們在 Document Foundation 的維基上建立了一套結構,以擷取有關 Calc 功能更詳細的參考資訊。

目標

如要填入維基結構的維基結構,請為每個 Calc 的函式撰寫更詳細的內容;標記遵循 ODFF 標準 (包含插圖和圖表) 很有用;提供一或兩個範例來表示極端案例和例外狀況,並提供範例/範例檔案。

專案工作計畫

我已徹底瞭解專案的核心概念,我們基本上是在記錄「函式精靈」中各項功能的運作方式,並提供充分範例,介紹函式的各項層面。此外,也請盡可能簡化說明文件,讓新使用者在短短幾秒內就能查詢並瞭解如何使用專案。

我想將這些函數細分為以下類別:

• 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 個函式,類別也很少。大部分都包含淺層說明,同時附上語法和一個範例。

我想為每個 Calc 的函式加入更詳細的內容,並標記符合 ODFF 標準的內容 (包括插圖和圖表),方便的話;提供一或兩個範例,說明商標的邊角案例和例外狀況,並提供範例/範例檔案。此外,您也可以視需要新增重要部分。 我會考慮以類別型式的方式處理這些函數,也就是拿起一個並直向工作,然後在技術撰寫期間改用其他類別。除了在社區養成期間,我會考慮習慣投入工作環境,在寫作階段讓工作變得更輕鬆。根據我的經驗,如果想發現記錄這類應用程式時經常發生許多「麻煩」時刻,就需要投入時間。 聰明時,我一開始會先進行這 11 個類別來推行專案,但有些需要較多的協助,因此需要較多時間,不過這些工作可以在工作期間處理。由於目前已經有幾份文件,我也將另外撰寫文件,並在每週的工作完成後進行校對,因為這不適合在上週告別。

以下概略整理了在時間限制內完成專案的規劃。

  • 第 1 週:(9 月 14 日) • 資料庫
  • 第 2 週:(9 月 21 日) • 日期和時間
  • 第 3 週:(9 月 28 日) • 金融
  • 第 4 週:(10 月 5 日) • 資訊
  • 第 5 週:(10 月 12 日) • 邏輯
  • 第 6 週:(10 月 19 日) • 數學
  • 第 7 週:(10 月 26 日) • 陣列
  • 第 8 週:(11 月) • 統計
  • 第 9 週:(11 月) • 試算表
  • 第 10 週:(11 月 16 日) • 文字
  • 第 11 週:(11 月 23 日) • 增益集
  • 第 12 週:(11 月 30 日 – 12 月 5 日)(最終)

其中記錄了這項專案完成的工作成果和經驗,以及處理輕微事務。如有必要,請在準備提交文件時,通過第 2 次驗證/編輯。