Ta strona zawiera szczegółowe informacje o projekcie polegającym na pisaniu tekstów technicznych, który został zaakceptowany w ramach Google Season of Docs.
Podsumowanie projektu
- Organizacja open source
- Globalny Wordnet
- Specjalista ds. technicznych:
- Kumar
- Nazwa projektu:
- The Open Multilingual Wordnet (OMW)
- Długość projektu:
- Standardowa długość (3 miesiące)
Opis projektu
Prośba o utworzenie projektu:
Kontaktowałem/kontaktowałam się z mentorami z Global Wordnet Association i przesłałem/przesłałam prośbę o przejęcie kodu, która została przez nich pozytywnie rozpatrzona. Jeśli mam możliwość, mogę poświęcić na ten projekt 40 godzin (lub więcej) tygodniowo. Mam dobrą znajomość Pythona, Git, HTML, C++, Java i C. Mówię płynnie po angielsku i hindi, w szkole nauczyłam się francuskiego, a także trochę niemieckiego. Jestem bardzo chętny i entuzjastycznie nastawiony do udziału w tym projekcie w ramach Global Wordnet Association. Jeśli otrzymam taką możliwość, będę pracować z największym oddaniem.
Obecny stan:
Obecna dokumentacja programu Open Multilingual Wordnet jest zwięzła i niekompletna. Istniejące przewodniki użytkownika nie zawierają treści, grafiki, przykładów ani wyraźnych instrukcji. Nie ma przewodnika użytkownika, który pomagałby w wyszukiwaniu w WordNet, odczytywaniu zwracanych stron, instalacji czy przesyłaniu opinii. Dostępna jest dokumentacja dotycząca przesyłania nowego Wordnetu, ale nie jest ona kompletna ani jasna, aby pomóc użytkownikowi w dołączeniu do Open Multilingual Wordnet. Nie ma dokumentacji dotyczącej korzystania z indeksu CILI (Collaborative Interlingual Index, CILI). Dostępna jest strona wprowadzająca do CILI, na której nie ma informacji o tym, dlaczego oraz jak je wycofać i zastąpić przez ocenianie nowych kandydatów. Ogólnie rzecz biorąc, obecna dokumentacja jest niejasna i nie zawiera wystarczającej ilości treści, przykładów ani materiałów wizualnych.
Abonament:
Planuję realizację tego projektu w 4 etapach. W etapie A opiszę w przewodniku, jak tworzyć dobrze sformatowany wordnet, jak go przesyłać i jak interpretować opinie. W następnej fazie B opracuję przewodnik dla osób, które szukają w wordnecie (lub w rodzince wordnetów) słów. W tej dokumentacji opiszę, jak czytać zwracane strony, jak je pobierać i jak przesyłać opinie. W etapie C opiszę interakcję z współdzielonym metryką interlingwistyczną, sposób wycofywania i zastępowania pojęć oraz oceniania nowych kandydatów. W etapie D wypełnię dokumentację Open Multilingual Wordnet i poprawię istniejącą dokumentację tego projektu, z wyjątkiem dokumentacji z etapów A, B i C. Projekty GWA się pokrywają, etap D zostanie też poświęcony na wymagania organizacyjne. Planuję przydzielić tygodnie 1,2 i 3 do etapu A, tygodnie 4,5 i 6 do etapu B, tygodnie 7,8 i 9 do etapu C oraz tygodnie 10 i 11 do etapu D.
Cele projektu:
1) Analiza istniejącej dokumentacji i określenie, która sekcja wymaga ulepszenia.
2) odtworzenie struktury istniejącej dokumentacji.
3) udokumentowanie przewodnika dla osób, które chcą dodać nowe słowo do WordNet.
4) Dokumentowanie przewodnika dla osób, które szukają w wordnet.
5) Opracowanie przewodnika po współpracy z współczesnym indeksem międzyjęzykowym.
6) dodanie przykładów i elementów wizualnych do dokumentacji.
7) Wypełnianie istniejących stron, na których dokumentacja wydaje się niewystarczająca.
Oś czasu:
Etap budowania społeczności: 17 sierpnia–13 września.
- W tym czasie będę mieć kontakt ze społecznością i bliżej jej poznam.
- Skonfiguruj kanał komunikacji.
- Ustaw czas komunikacji.
- Doprecyzuj cele i określ oczekiwania po obu stronach.
Etap tworzenia dokumentów (14 września – 30 listopada)
- Będę ściśle współpracować z moim mentorem i dokończyć projekt na tym etapie zgodnie z cotygodniowymi planami.
- Wypełnij ankietę przesłaną przez administratorów programu Google.
Tydzień 1–3 (14–27 września)
- Dokumentacja – etap A
Tydzień 1 (14–20 września)
- Rozpocznie się dokumentacja przewodnika dla osoby przesyłającej nową Wordnet.
- W tym tygodniu zajmę się dokumentacją, aby dowiedzieć się, jak utworzyć poprawnie sformatowany Wordnet.
- Zostaną udokumentowane przejrzyste instrukcje konwertowania słownika użytkownika do publicznej definicji typu dokumentu Wordnet LMF (DTD).
- Będzie ona dotyczyć również narzędzi do konwersji.
Tydzień 2 (21–27 września)
- W tym tygodniu przygotuję dokumentację dotyczącą przesyłania do OMW własnych danych wordnet (po przekonwertowaniu na definicję typu dokumentu Wordnet LMF).
- Obecna dokumentacja jest powierzchowna (ale dokładna). Uzupełnię ją i dodam przykłady.
Tydzień 3 (28 września – 4 października)
- Ten tydzień posłuży do dokumentacji, która pomoże Ci zrozumieć te opinie.
- Ta dokumentacja musi zostać napisana od podstaw, ponieważ nie ma żadnej dokumentacji na ten temat.
Tydzień 4–6 (5–25 października)
- Dokumentacja – etap B
Tydzień 4 (5–11 października)
- W tym tygodniu zacznę dokumentować przewodnik dla osób, które szukają w słownikach WordNet (lub w rodzinie słowników WordNet).
- W tym tygodniu napiszę dokumentację dotyczącą odczytywania zwracanych stron.
Tydzień 5 (12–18 października)
- W tym tygodniu opiszę, jak pobrać pliki.
- Nie ma dokumentacji na ten temat, trzeba ją napisać od podstaw.
Tydzień 6 (19–25 października)
- W tym tygodniu opiszę, jak przesłać opinię organizacji.
- Ponieważ nie ma żadnej dokumentacji, na której można się wzorować, ta dokumentacja zostanie napisana od podstaw.
Tydzień 6–9 (26 października – 15 listopada)
- Etap dokumentacji C
Tydzień 7 (26 października – 1 listopada)
- W tym tygodniu zacznę dokumentować przewodnik po interakcji z współpracy międzyjęzykowej (CILI).
- W tym tygodniu opiszę, jak i dlaczego wycofywać i zastępować pojęcia.
Tydzień 8 (2–8 listopada)
- W tym tygodniu udostępnię dodatkowe informacje o CILI oraz instrukcje pobierania CILI i spełniania wymagań organizacyjnych dotyczących dokumentacji CILI. Ta dokumentacja musi zostać napisana od podstaw.
Tydzień 9–11 (9–29 listopada)
- Dokumentacja – etap D
Tydzień 9 (9–15 listopada)
- OMW 2.0 będzie teraz rozwijane zgodnie z potrzebami organizacji.
Tydzień 10 (16–22 listopada)
- Dokumentacja strony głównej Open Multilingual Wordnet (OMW) wydawała mi się wąska. W tym tygodniu zajmę się nią i dodam dodatkowe informacje związane z OMW, a także sprawdzę, które inne strony tego typu należy uzupełnić.
- Strony, na których brakuje treści, zostaną ulepszone, a gdy tylko będzie to możliwe, dodam do nich treści wizualne.
Tydzień 11 (23–29 listopada)
- Ponieważ projekty GWA się pokrywają, ten tydzień jest zarezerwowany na realizację tych nakładających się potrzeb organizacyjnych i innej dokumentacji.
Etap finalizacji i oceny projektu (30 listopada–5 grudnia)
- Ten tydzień poświęcimy na sprawdzenie dokumentacji pod kątem literówek i błędów.
- Napiszę raport z projektu.
- Poproszę moich mentorów o sprawdzenie mojego sprawozdania z projektu.
- Zakończę i prześlę raport projektu.
- Napiszę i prześlę ocenę moich mentorów i moje doświadczenie w Season of Dokumenty.
Komunikacja:
Częstotliwość kontaktów będzie zależeć od rozmów z mentorami. Wolę regularną komunikację – proponuję, aby dwa razy w tygodniu przesyłać aktualne informacje i otrzymywać opinie na temat dotychczasowych działań. Jest to jednak elastyczne także w zależności od ich preferencji.
Dlaczego ten projekt?
Interesuję się językoznawstwem, a idea połączenia sieci WordNet dla wszystkich języków świata zainspirowała mnie do dołączenia do Global Wordnet Association i wniesienia wkładu w ten projekt. Koncepcja Open Multilingual Wordnet jest godna podziwu, ponieważ poszczególne sieci WordNet są połączone z sieciami w innych językach, co ułatwia ich dostępność. Każdy może dowolnie korzystać z Open Multilingual Wordnet i jego komponentów, modyfikować je i udostępniać w dowolnym celu. Chociaż GWA ma dobry pomysł i szlachetne intencje, organizacja nie jest zbyt znana i nie doceniana. Jednym z powodów jest prawdopodobnie skąpa dokumentacja i brak przewodników dla użytkowników, którzy chcą dodawać treści i z nich korzystać. Uznałem, że projekt Open Multilingual Wordnet jest czymś, w którym mogę pomóc Global Wordnet Association i społeczności zajmującej się oprogramowaniem typu open source.
Przyszłe plany:
Po ukończeniu GSoD 20 nadal będę wspierać Global Wordnet Association w ramach innych projektów. Jeśli pojawi się taka możliwość, chętnie wezmę udział w każdej konferencji organizacji.