本頁面包含 Google 技術文件季度接受的技術寫作專案詳細資料。
專案摘要
- 開放原始碼組織:
- Global Wordnet
- 技術文件撰稿者:
- 庫馬
- 專案名稱:
- 多語言開放式字詞網 (OMW)
- 專案長度:
- 標準長度 (3 個月)
Project description
專案要求:
我曾與 Global Wordnet Association 導師聯絡,並提交了他們認為值得審查的拉取要求。 如果有機會,我每週可以花 40 小時 (或更長時間) 投入這個專案。 我對 Python、Git、HTML、C++、Java 和 C 有充分的瞭解。我會說兩種語言,可以流利地說英文和北印度文,我在學校學過法文,也懂一點德文。若願意盡全力,以此專案為全球 Wordnet 協會貢獻一己之力,我深感熱情和熱忱。
目前狀態:
目前的 Open 多語言 Wordnet 說明文件僅含括內容淺顯易懂,且不完整的現有使用者指南缺少內容、圖像、範例和明確指示。沒有使用者指南可協助使用者搜尋 WordNet、如何閱讀搜尋結果頁面、如何安裝、如何提供意見回饋。部分說明文件包含在提供新的 Wordnet 內容,但該說明文件並不夠明確,無法引導使用者如何加入 Open Multilingual Wordnet。沒有說明文件說明如何與協同跨語言索引 (CILI) 互動,雖然有 CILI 簡介頁面,但缺少相關資訊,例如為何及如何淘汰和取代概念、評估新候選項目。整體而言,目前的說明文件缺乏內容、清晰度、範例和輔助圖像。
方案:
我預計分四個階段執行這項專案。在第 A 階段,我會為貢獻新詞彙網的使用者編寫指南,說明如何建立格式正確的詞彙網、上傳詞彙網,以及如何解讀意見回饋。在下一階段 B 中,我會為搜尋 WordNet (或 WordNet 系列) 的使用者編寫指南,在該文件中,我會說明如何閱讀傳回的網頁、如何下載,以及如何提供意見回饋。在 C 階段,我會記錄如何與協作跨語言索引互動的指南,以及如何淘汰和取代概念,並在 C 階段記錄判斷新候選項目的相關資訊。在第 D 階段,我會填入 Open Multilingual Wordnet 的說明文件,並改善這個專案的現有說明文件 (不包括第 A、B 和 C 階段的說明文件)。由於 GWA 專案之間存在重疊,第 D 階段也會專注於機構需求。我已將第 1、2 和 3 週分配給第 A 階段,第 4、5 和 6 週分配給第 B 階段,第 7、8 和 9 週分配給第 C 階段,第 10 和 11 週分配給第 D 階段。
專案目標:
1) 分析現有說明文件,並判斷哪個部分需要改善。
2) 重新建構現有說明文件的結構。
3) 記錄參與新 Wordnet 的人。
4) 記錄搜尋 Wordnet 的使用者。
5) 編寫指南,說明如何與協同跨語言索引互動。
6) 在說明文件中新增範例和圖像。
7) 填入說明文件內容較少的現有頁面。
時間表:
社群凝聚階段:8 月 17 日至 9 月 13 日。
- 在這段期間,我會與社群成員交流,並深入瞭解這個社群。
- 設定溝通管道。
- 設定溝通時間。
- 調整目標,並設定雙方的期望。
文件開發階段 (9 月 14 日至 11 月 30 日)
- 我會與導師密切合作,並按照每週計畫完成這個階段的專案。
- 完成 Google 計劃管理員製作的問卷調查。
第 1 至 3 週 (9 月 14 日至 27 日)
- 說明文件階段 A
第 1 週 (9 月 14 日至 20 日)
- 我們將開始為貢獻新詞彙網的使用者編寫指南說明文件。
- 本週我會製作說明文件,說明如何建立格式正確的 WordNet。
- 我們會提供明確的說明文件,說明如何將使用者的 WordNet 轉換為公開的 WordNet LMF 文件類型定義 (DTD)。
- 轉換工具也會納入其中。
第 2 週 (9 月 21 日至 27 日)
- 本週我會撰寫說明文件,說明如何將 WordNet 上傳至 OMW (在轉換為 WordNet LMF 文件類型定義後)。
- 現有的說明文件內容不多 (但正確),我會填入內容,並在說明文件中加入範例。
第 3 週 (9 月 28 日至 10 月 4 日)
- 本週將用於說明如何解讀意見回饋。
- 由於目前沒有相關說明文件,因此必須從頭開始撰寫。
第 4 到 6 週 (10 月 5 日至 25 日)
- 說明文件階段 B
第 4 週 (10 月 5 日至 11 日)
- 本週我將開始為搜尋 WordNet (或 WordNet 家族) 的使用者編寫指南。
- 本週我將撰寫說明文件,說明如何讀取傳回的頁面。
第 5 週 (10 月 12 日至 18 日)
- 本週我會記錄下載方式。
- 這項功能目前沒有現有的說明文件,因此需要從頭撰寫。
第 6 週 (10 月 19 日至 25 日)
- 本週我將記錄向機構提供意見回饋的方式。
- 先前沒有參考文件可以參考,因此這部分也會從頭開始編寫。
第 6 到 9 週 (10 月 26 日至 11 月 15 日)
- 說明文件階段-C
第 7 週 (10 月 26 日至 11 月 1 日)
- 本週我將開始撰寫說明文件,說明如何與協同跨語言索引 (CILI) 互動
- 本週我將說明如何及為何淘汰和取代概念。
第 8 週 (11 月 2 日至 8 日)
- 本週我會記錄 CILI 的其他資訊,並撰寫操作說明,說明如何下載 CILI,並滿足 CILI 說明文件的機構規定,這份說明文件需要從頭撰寫。
第 9 到 11 週 (11 月 9 日至 29 日)
- 說明文件階段 D
第 9 週 (11 月 9 日至 15 日)
- 即日起,將根據組織需求開發 OMW 2.0。
第 10 週 (11 月 16 日至 22 日)
- Open Multilingual Wordnet (OMW) 首頁的說明似乎不夠詳細,我會在本週著手處理,並新增與 OMW 相關的其他資訊,同時也會查看需要填入其他 OMW 現有網頁的內容。
- 我們會改善缺少 OMW 頁面的情況,並盡可能在其中加入視覺效果。
第 11 週 (11 月 23 日至 29 日)
- 由於 GWA 專案有重疊之處,本週將用來滿足這些重疊的組織需求,以及其他各種文件。
專案定案和評估階段 (11 月 30 日至 12 月 5 日)
- 本週將會花時間校對說明文件,找出拼寫錯誤和錯誤。
- 我會撰寫專案報告。
- 我會請導師審查我的專案報告。
- 我會完成並提交專案報告。
- 我會針對導師和 Docs 季節的體驗撰寫並提交評估。
通訊:
與導師的聯絡頻率取決於雙方的討論結果。我希望能定期與你溝通,建議每週進行兩次溝通,以便提供最新資訊,並接收對目前工作進度的意見回饋。不過,這類廣告會因他們的偏好而異。
參與這項專案的原因
我對語言學很感興趣,而且很想將世界各國的詞彙連結起來,因此加入了全球詞彙網協會,並為這個專案貢獻心力。Open Multilingual Wordnet 的概念非常值得讚許,因為它可將個別的 Wordnet 連結至其他語言的 Wordnet,讓使用者更容易存取這些 Wordnet。任何人都可以自由使用、修改及分享開放式多語詞彙網及其元件,用途不限。雖然 GWA 是一個堅實的想法和偉大的意圖,但該組織並不知名且弱勢族群。其中一個原因可能是說明文件內容不夠豐富,也沒有使用者指南協助使用者貢獻內容和使用該工具。我認為,Open Multilingual Wordnet 專案是我可以貢獻心力,協助 Global Wordnet Association 和開放原始碼社群共同合作的專案。
未來計畫:
完成 GSoD 20 後,我也會繼續在其他專案中為 Global Wordnet Association 做出貢獻。如果願意,我一定會參加機構的任何會議。