本頁針對 Google 系列文件接受的技術撰寫專案提供詳細資料。
專案摘要
- 開放原始碼機構：
- FOLIO
- 技術文件撰寫者：
- gallinita
- 專案名稱：
- FOLIO 應用程式使用者說明文件擴充
- 專案長度：
- 長時間執行 (5 個月)
Project description
針對這個專案，我打算建立及更新指定使用者的 FOLIO 說明文件。FOLIO 是程式庫管理系統，因此使用者為圖書館人員。目前，FOLIO 維基 (https://wiki.folio.org/) 包含部分文件，但內容最少，也沒有採用以圖書館人員為考量的易於理解的格式。這項專案建立的新說明文件會託管於特定的說明文件知識庫 (可從 FOLIO 的應用程式存取)，並包含與系統及其程式庫使用者相關的工作流程。我們會在網站上發布初始文件，首先是循環和課程保留功能。我想在這項「長時間執行」專案的過程中，盡可能提供所需說明文件。
我曾與 Marcia Borensztajn 討論 FOLIO 說明文件專案，並討論 FOLIO 的需求和目前的文件情況。如前所述，FOLIO 說明文件必須更新、擴充及重新處理，才能成功協助使用者。需要建立說明文件，以反映標準程式庫處理程序，且 FOLIO 包含可以搭配運作的不同「應用程式」，因此必須通盤解釋系統。因為我是圖書館員，我很熟悉 FOLIO 使用者可能會遇到的情境和工作流程類型，因而需要幫助。Marcia 正致力於使用 Markdown、Git 和 Hugo 建立新的文件知識庫。系統會在此專案中建立 FOLIO 的新說明文件，並做為未來架構使用。