本頁針對 Google 系列文件接受的技術撰寫專案提供詳細資料。
專案摘要
- 開放原始碼機構：
- 全球 Wordnet 關聯
- 技術文件撰寫者：
- Yoyo Wu
- 專案名稱：
- Wordnet 結構
- 專案長度：
- 標準長度 (3 個月)
Project description
這項專案的原因
身為專職語言撰寫技術的技術文件撰寫者，我很開心能找到這樣的專案，考慮將不同語言與語意化架構連結在一起，並應用在 Google 翻譯等現實生活中。我想參與這項專案的說明文件，讓學員更容易理解。
問題
我已詳讀原始文件，認為可以解決下列問題來改善文件： 一開始我們缺乏「總覽」部分，介紹字詞網路的基本概念，對新手來說非常實用。 雖然 Wordnet 的所有關係都以統一範本推出，但某些關係缺乏必要資訊，例如：Princeton Wordnet 網頁、EuroWordnet 一般指南和其他資源。簡短定義、定義、簡短示例和範例缺少統一的語句模式，因為當使用者將滑鼠懸停在特定關係上時，簡短定義和簡短範例屬於摘要，其主要是用來引導關聯之間的關係，因此這些內容應統一且模式，與簡要的對應模式不同。 雖然測試來自 EWN，但條件區塊應優先於主要測試主體，因為使用者一律會先查看條件，判斷其語言資料是否符合條件，再進行測試。測試主體也不夠直接，含有大量語言縮寫。「留言」專區的內容五花八門，有時會強調某項定義，有時甚至會說明專案專屬的細節。我認為這個專區應設定標準，讓使用者能將特定專案的相關資訊移到「專案專屬名稱」專區。「專案專屬名稱」專區會匯總所有專案中的關係名稱，但發生不一致錯誤，因此需要審查這個區段。需要將詞彙表直接連結至文件，並把初學者可能不熟悉的所有縮寫和字詞加入文件中。
規範
此外，我還想與專案團隊在擬定文件草稿之前，與專案團隊討論以下兩個主題，得到的結論是整個專案通用的指南。
向觀眾介紹 雖然這是我的真實範例，但我只是個語言學家，但一開始查看原始文件時，我不知道「合成」的意思是出現在 Princeton Wordnet 網頁上，我發現那組程式碼的意思卻是 Princeton Wordnet。
因此，首先我們需要掌握潛在目標對象的知識結構，如果無法確定所有目標對像都具備相關知識，則至少需要加入「總覽」部分，然後連結詞彙表和其他相關資源，引導他們瞭解用語和相關專案。在整個記錄過程中，我們始終 將此假設
關於文件的功能 根據我的理解，Wordnet 結構文件的目標是協助使用者熟悉 wordnet 中的所有關係類型，而使用者可以根據提供的資訊將字詞分組成這些關係。不過，原始文件看起來更像學術論文的摘錄。如果文件的用途是做為學術參考來源也沒有問題，但如果其旨在協助引導使用者，就必須在學術界與實用性之間做出取捨。
優點
我可以幫忙翻譯中文版文件。我有將英文翻譯成中文翻譯的經驗。 我可以協助設定文件格式、瞭解 HTML/CSS 的基本知識，也希望能夠協助改善文件網頁的外觀，例如新增側邊導覽列。 如果流程圖可以協助使用者進一步瞭解關係，我可以使用 Visio 或 Mermaid 繪製一些流程圖。
里程碑 / 時間 / 目標
- 第 1 週：與專案團隊討論並討論目標、工作流程和工作計畫。
- 第 2 週：簡要說明文件大綱，並撰寫「總覽」部分。
- 第 3 週 - 第 4 週：寫下組成關係部分。
- 第 5 週 – 第 6 週：寫下其他與網域關係部分。
- 第 7 週 - 第 8 週：寫下「角色關係」部分。
- 第 9 週：寫下其餘三個關係，並更新詞彙表。
- 第 10 週：視需要翻譯中文版本。
- 第 11 週：修改文件格式。
- 第 12 週：最終檢查及摘要這項專案。