פרויקט Global Wordnet Association

בדף הזה מפורטים פרטי פרויקט של כתיבה טכנית שאושר להשתתפות בתוכנית Google Season of Docs.

סיכום הפרויקט

ארגון קוד פתוח:

Global Wordnet

כותבים טכניים:

קומאר

שם הפרויקט:

Open Multilingual Wordnet‏ (OMW)

אורך הפרויקט:

אורך רגיל (3 חודשים)

תיאור הפרויקט

בקשת הפרויקט:

יצאתי בקשר עם מדריכים של Global Wordnet Association ושלחתי בקשת משיכה (pull request) שעבר בהצלחה את הבדיקה שלהם. אם תהיה לי הזדמנות, אוכל להקדיש לפרויקט הזה 40 שעות (או יותר) בשבוע. יש לי הבנה טובה של Python,‏ Git,‏ HTML,‏ C++,‏ Java ו-C. אני דו-לשונית ואני יכולה לדבר אנגלית והינדית באופן שוטף. למדתי צרפתית בבית הספר ואני גם יודעת קצת גרמנית. אני מאוד רוצה לתרום לארגון Global Wordnet Association באמצעות הפרויקט הזה, ואם תהיה לי הזדמנות, אעבוד במסירות רבה.

המצב הנוכחי:

המסמכים הקיימים של Open Multilingual Wordnet הם שטחיים וחסר בהם תוכן, גרפיקה, דוגמאות והוראות מפורטות. אין מדריך למשתמש שיעזור למישהו שמחפש ב-wordnet, איך לקרוא את הדפים שהוחזרו, איך להתקין, איך לתת משוב. יש מסמכים מסוימים בנושא הוספת רשומות חדשות ל-WordNet, אבל הם לא מלאים ולא ברורים מספיק כדי להנחות אנשים איך להצטרף ל-Open Multilingual Wordnet. אין תיעוד לגבי האינטראקציה עם Collaborative Interlingual Index‏ (CILI). יש דף מבוא ל-CILI, שבו חסר מידע כמו למה ואיך מבטלים מושגים ומחליפים אותם, ובוחנים מועמדים חדשים. באופן כללי, במסמכי העזרה הקיימים חסר תוכן, בהירות, דוגמאות וחומרים חזותיים.

תוכנית:

תכננתי לבצע את הפרויקט הזה בארבעה שלבים. בשלב א', אצור מדריך למשתמש שמוסיף Wordnet חדש. בשלב הזה אדבר על יצירת Wordnet בפורמט תקין, איך להעלות אותו ואיך לפרש את המשוב. בשלב הבא (שלב ב'), אכתוב מדריך למשתמש שמחפש ב-WordNet (או במשפחה של רשתות WordNet). במסמך הזה אציג הסבר על קריאת הדפים שהוחזרו, על הורדה ועל שליחת משוב. בשלב ג' אכתוב מדריך לאינטראקציה עם ה-Collaborative Interlingual Index, איך להוציא מושגים משימוש ולהחליף אותם, ואיך לשפוט מועמדים חדשים. בשלב ד', אני אכלס את התיעוד של Open Multilingual Wordnet ואשפר את התיעוד הקיים של הפרויקט הזה מלבד התיעוד שמתואר בשלבים A, B ו-C. מאחר שיש חפיפה בין הפרויקטים של GWA, שלב ד' ימוקד גם לדרישות הארגון. תכננתי להקצות את השבועות 1,2 ו-3 לשלב א', את השבועות 4,5 ו-6 לשלב ב', את השבועות 7,8 ו-9 לשלב ג' ואת השבועות 10 ו-11 לשלב ד'.

יעדי הפרויקט:

1) ניתוח המסמכים הקיימים וקביעת הקטע שדורש שיפור.

2) שחזור המבנה של המסמכים הקיימים.

3) תיעוד המדריך למשתמש שמוסיף WordNet חדש.

4) תיעוד מדריך למי שמחפש ב-WordNet.

5) תיעוד מדריך לאינטראקציה עם האינדקס המשותף של שפות שונות.

6) הוספת דוגמאות ומחשות ויזואליות למסמכי התיעוד.

7) אכלוס הדפים הקיימים כאשר התיעוד נראה רדוד.

קו זמן‬

• שלב יצירת הקשרים בקהילה: 17 באוגוסט עד 13 בספטמבר.

  • במהלך התקופה הזו אהיה בקשר עם הקהילה ואכיר אותה טוב יותר.
  • הגדרת ערוץ תקשורת.
  • מגדירים זמן תקשורת.
  • משפרים את היעדים ומגדירים ציפיות משני הצדדים.

• שלב פיתוח המסמך (14 בספטמבר – 30 בנובמבר)

  • אעבוד בשלב הזה בשיתוף פעולה הדוק עם המנטורים שלי ואשלים את הפרויקט בהתאם לתוכניות השבועיות.
  • ממלאים את כל הסקר של מנהלי התוכנית של Google.

• שבוע 1-3 (14 עד 27 בספטמבר)

  • שלב א' של תיעוד

• שבוע 1 (14 עד 20 בספטמבר)

  • נתחיל לכתוב מסמכי עזרה למדריך לאנשים שתורמים רשתות מילים חדשות.
  • השבוע אכתוב את המסמך בנושא יצירת רשת מילים בפורמט תקין.
  • תיכתבו הוראות ברורות להמרת מילון המילים של המשתמש להגדרת סוג המסמך (DTD) הציבורית של Wordnet LMF.
  • בנוסף, נסביר על כלים למעקב המרות.

• שבוע 2 (21 עד 27 בספטמבר)

  • השבוע אכתוב את המסמך עם ההוראות להעלאת מילון Wordnet (אחרי המרה להגדרת סוג המסמך של Wordnet LMF) ל-OMW.
  • המסמך הקיים קצר (אבל מדויק). אאכלס אותו ואוסיף לו דוגמאות.

• שבוע 3 (28 בספטמבר עד 4 באוקטובר)

  • השבוע נשתמש בתיעוד כדי להבין את המשוב.
  • צריך לכתוב את המסמך הזה מאפס, כי אין מסמך קיים בנושא הזה.

• שבוע 4 עד 6 (5-25 באוקטובר)

  • שלב ב': תיעוד

• שבוע 4 (5 עד 11 באוקטובר)

  • השבוע אתחיל לכתוב מדריך למשתמש שמחפש ב-WordNet (או במשפחה של רשתות WordNet).
  • השבוע אכתוב מסמך תיעוד עם הוראות לקריאת הדפים שהוחזרו.

• שבוע 5 (12-18 באוקטובר)

  • השבוע אראה איך מורידים.
  • אין מסמך תיעוד קיים לכך, וצריך לכתוב אותו מאפס.

• שבוע 6 (19-25 באוקטובר)

  • השבוע אראה איך לשלוח משוב לארגון.
  • מכיוון שאין מסמכים קודמים שאפשר להיעזר בהם, גם המסמך הזה יכתב מהתחלה.

• שבוע 6-9 (26 באוקטובר עד 15 בנובמבר)

  • שלב תיעוד ג'

• שבוע 7 (26 באוקטובר עד 1 בנובמבר)

  • השבוע אתחיל לכתוב את המסמך של המדריך לעבודה עם Collaborative Interlingual Index‏ (CILI)
  • השבוע אכתוב איך ומתי כדאי להוציא משימוש מושגים ולהחליף אותם במושגים חדשים.

• שבוע 8 (2-8 בנובמבר)

  • השבוע אכתוב מידע נוסף על CILI ואוריד הוראות להורדת CILI ולביצוע הדרישות הארגוניות במסמכי התיעוד של CILI. המסמכים האלה צריכים להיכתב מהתחלה.

• שבוע 9-11 (9 עד 29 בנובמבר)

  • שלב תיעוד-ד'

• שבוע 9 (9 עד 15 בנובמבר)

  • עכשיו נפתח פיתוח של OMW 2.0 בהתאם לצרכים הארגוניים.

• שבוע 10 (16 עד 22 בנובמבר)

  • תיעוד דף הבית של Open Multilingual Wordnet‏ (OMW) נראה שטחי. השבוע אעבוד עליו ואוסיף את המידע הנוסף שקשור ל-OMW. בנוסף, אבדוק אילו דפים קיימים אחרים של OMW צריך לאכלס.
  • דפים חסרים של OMW ישתפרו, ובכל הזדמנות אפשרית אנסה להוסיף להם רכיבים חזותיים.

• שבוע 11 (23 עד 29 בנובמבר)

  • יש חפיפה בפרויקטים של GWA, ולכן השבוע הזה מיועד למלא את הצרכים הארגוניים החופפים האלה ולטיפול במסמכים שונים.

• שלב השלמת הפרויקט והערכה שלו (30 בנובמבר עד 5 בדצמבר)

  • השבוע נקדיש להגהה של המסמכים כדי למצוא שגיאות הקלדה ושגיאות אחרות.
  • אכתוב את דוח הפרויקט שלי.
  • אצטרך לבקש מהמנחים שלי לבדוק את דוח הפרויקט שלי.
  • אשליך את דוח הפרויקט שלי.
  • אכתוב ואשלח הערכה על המנטורים שלי ועל החוויה שלי בתוכנית 'עונה של מסמכים'.

תקשורת:

תדירות הקשר תלויה בשיחה עם המנטורים. אני מעדיף תקשורת סדירה – ההצעה שלי היא שנעדכן פעמיים בשבוע כדי לקבל משוב על העבודה שביצענו עד כה. עם זאת, האפשרות הזו גמישה בהתאם להעדפות שלהם.

למה דווקא הפרויקט הזה?

אני מתעניין בלשון, והרעיון לחבר רשתות של מילים לכל השפות בעולם ריתק אותי והביא אותי להצטרף לארגון Global Wordnet Association ולתרום לפרויקט הזה. הרעיון של Open Multilingual Wordnet הוא מצוין, כי רשתות מילים נפרדות מקושרות לרשתות מילים בשפות אחרות, וכך קל יותר לגשת לרשתות המילים האלה. כל אחד יכול להשתמש ב-Open Multilingual Wordnet וברכיבים שלו, לשנות אותם ולשתף אותם באופן חופשי לכל מטרה. למרות של-GWA יש רעיון מוצק וכוונה אצולה, הארגון לא הרבה ידוע ולא מקבל קרדיט נמוך מדי. סיבה אפשרית לכך היא מסמכי עזרה שטחיים וחוסר במדריכים למשתמש שיעזרו לתרום לפרויקט ולהשתמש בו. הבנתי שהפרויקט Open Multilingual Wordnet הוא משהו שבו אני יכול לתרום כדי לסייע ל-Global Wordnet Association ולקהילת הקוד הפתוח במשותף.

תוכניות עתידיות:

אחרי שנסיים את GSoD 20, אמשיך לתרום לארגון Global Wordnet Association גם בפרויקטים אחרים. אם תהיה לי הזדמנות, אשתתף בכנסים של הארגון.