本頁將詳細說明 Google Season of Docs 接受的技術文件寫作專案。
專案摘要
- 開放原始碼組織：
- LibreOffice
- 技術撰稿人：
- 韓國
- 專案名稱：
- Calc 函式參考資料和使用手冊
- 專案長度：
- 標準長度 (3 個月)
Project description
專案要求
在技術寫作階段，我每週可以輕鬆撥出 30 到 35 個小時，在預寫階段中則可 10 到 12 小時學習任何對於專案所需的技能。在此提醒你，目前我住在我的大學(居住國家/地區) 目前居住在我的大學，因此可以上網快速地取得專案所需的任何額外資源。由於目前 COVID-19 疫情，我馬上就會從我的大學中繼續上課，畢竟目前，我的大學計劃馬上就要開始上課了。
簡介
LibreOffice Calc 提供多個類別的函式 (超過 500 個)，但說明文件的內容相當簡略 (但仍正確)。Calc 內建的函式精靈也會為使用者提供各函式的用途和參數的摘要資訊。我們已在 The Document Foundation 的 wiki 中建立結構，以便收錄 Calc 函式的詳細參考資訊。
目標
如要為每個 Calc 函式撰寫更詳細的內容，以填入 Wiki 結構，建議您標示遵循 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 月 2 日) • 統計
- 第 9 週：(11 月 9 日) • 試算表
- 第 10 週：(11 月 16 日) • 文字
- 第 11 週：(11 月 23 日) • 外掛程式
- 第 12 週：(11 月 30 日至 12 月 5 日)(最終)
記錄完成的工作和從這個專案中獲得的經驗，並處理次要事項，包括視需要進行第 2 次校對/編輯，以便準備好提交文件。