Ta strona zawiera szczegółowe informacje na temat projektu technicznego przyjęta do programu Sezon Dokumentów Google.
Podsumowanie projektu
- Organizacja open source:
- Global Wordnet
- Pisarz techniczny:
- Kumar
- Nazwa projektu:
- The Open Multilingual Wordnet (OMW)
- Długość projektu:
- Standardowa długość (3 miesiące)
Opis projektu
Prośba dotycząca projektu:
Mam kontakt z mentorami z Global Wordnet Association i przesłałem prośbę o przesłanie, która została przez nich pozytywnie rozpatrzona. Jeśli będzie to możliwe, będę w stanie poświęcić na projekt 40 godzin tygodniowo (lub dłużej). Dobrze znam Pythona, Gita, HTMLa, C++, Javę i C. Jestem dwujęzyczna, biegle posługuję się językiem angielskim i hindi. Nauczyłem się francuskiego w szkole i znam się trochę po niemiecku. Jeśli tylko będzie taka możliwość, chętnie włączymy się do tego projektu w globalnym stowarzyszeniu Wordnet Association.
Bieżący stan:
Obecna dokumentacja Open Multilingual Wordnet jest niewielka, a w istniejących przewodnikach użytkownika brakuje treści, grafiki, przykładów i szczegółowych instrukcji. Nie ma żadnego przewodnika użytkownika, który mógłby pomóc w przeszukaniu witryny wordnet, poznaniu zwróconych stron, instalacji i przekazywaniu opinii. W przypadku publikowania nowego programu Wordnet dostępna jest pewna dokumentacja, która nie jest kompletna ani niezrozumiała, aby wskazać, jak dołączyć do otwartego wielojęzycznego programu Wordnet. Nie ma dokumentacji dotyczącej korzystania z narzędzia Collaborative Interlingual Index (CILI). Na stronie wprowadzającej CILI brakuje informacji na temat tego, dlaczego i jak wycofywać i zastępować koncepcje oraz ocenić nowych kandydatów. Ogólnie w aktualnej dokumentacji brakuje treści, przejrzystych treści, przykładów i treści wizualnych, które mogłyby pomóc w rozwiązaniu problemu.
Abonament:
Zamierzam zrealizować ten projekt w 4 fazach. Na etapie A udokumentuję przewodnik dla osób tworzących nową sieć Wordnet. Na tym etapie omówimy tworzenie dobrze sformatowanego oprogramowania wordnet, przesyłanie go i rozumienie opinii. W kolejnej fazie B udokumentuję przewodnik dla osób przeszukujących sieć słów (tzw. wordnet). W tej dokumentacji przedstawię sposób odczytywania zwróconych stron, ich pobierania i przekazywania opinii. W fazie C udokumentuję przewodnik dotyczący korzystania ze wspólnego indeksu międzyjęzycznego, wycofywania i zastępowania koncepcji oraz oceniania nowych kandydatów. W ramach etapu D uzupełnię dokumentację Open Multilingual Wordnet i ulepszy istniejącą dokumentację tego projektu. Projekty GWA pokrywają się, więc faza D jest również poświęcona wymaganiom organizacyjnym. Zamierzam przydzielić tygodnie 1,2 i 3 do fazy A. Tydzień 4, 5 i 6 zostanie przypisany do fazy B,7, 8 i 9 do fazy C,a tygodni 10 i 11 do fazy D.
Cele projektu:
1) Przeanalizować istniejącą dokumentację i określić, która sekcja wymaga ulepszenia.
2) Odtworzenie struktury istniejącej dokumentacji.
3) Udokumentować przewodnik dla osoby publikującej nową sieć Wordnet.
4) Udokumentuj przewodnik dla osoby przeszukującej system Wordnet.
5) Udokumentowanie przewodnika po interakcji ze Wspólnym indeksem międzyjęzykowym.
6) Dodanie przykładów i materiałów wizualnych do dokumentacji.
7) Wypełnianie istniejących stron, na których dokumentacja wydaje się być płytka.
Oś czasu:
Etap budowania więzi ze społecznością: 17 sierpnia – 13 września.
- W tym czasie będę kontaktować się ze społecznością i lepiej jej poznać.
- Skonfiguruj kanał komunikacji.
- Ustaw czas komunikacji.
- Uściślij cele i określ oczekiwania po obu stronach.
Etap opracowywania dokumentów (14–30 listopada)
- Będę ściśle współpracować z mentorami i ukończyć mój projekt w tej fazie zgodnie z tygodniowymi planami.
- Wypełnij dowolne ankiety od 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 osób publikujących nowe treści.
- W tym tygodniu zaprezentuję dokumentację dotyczącą tworzenia dobrze sformatowanego programu Wordnet.
- Zostanie udokumentowana instrukcja konwertowania wordneta użytkownika na publiczną definicję typu dokumentu Wordnet LMF (DTD).
- Omówimy także narzędzia do konwersji.
Tydzień 2 (21–27 września)
- W tym tygodniu opracuję dokumentację dotyczącą przesyłania programu wordnet (po przekonwertowaniu na definicję typu dokumentu Wordnet LMF) do OMW.
- Istniejąca dokumentacja jest płytka (ale dokładna). Wypełnię ją i dodam przykłady do dokumentacji.
Tydzień 3 (28 września – 4 października)
- W tym tygodniu zapoznamy się z tym, jak interpretować opinie.
- Ta dokumentacja musi zostać napisana od podstaw, ponieważ nie mamy jeszcze 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 przeszukują system Wordnet (czyli rodzinę słów kluczowych).
- W tym tygodniu przygotuję dokumentację dotyczącą odczytywania zwróconych stron.
Tydzień 5 (12–18 października)
- W tym tygodniu pokażę, jak pobrać aplikację.
- Nie istnieje żadna dokumentacja tego procesu. Musisz go napisać od zera.
Tydzień 6 (19–25 października)
- W tym tygodniu opiszę sposób przekazywania opinii do organizacji.
- Nie ma poprzedniej dokumentacji, z której można się odwoływać, dlatego zostanie ona napisana od zera.
Tydzień 6–9 (26 października–15 listopada)
- Dokumentacja – etap C
Tydzień 7 (26 października–1 listopada)
- W tym tygodniu zacznę dokumentację przewodnika po interakcji z indeksem CILI (Collaborative Interlingual Index)
- W tym tygodniu udokumentuję, jak i dlaczego można wycofywać i zastępować koncepcje.
Tydzień 8 (2–8 listopada)
- W tym tygodniu udokumentuję dodatkowe informacje na temat CILI i napiszę instrukcje dotyczące pobierania CILI i spełniania wymagań organizacyjnych w dokumentacji CILI. Ta dokumentacja musi zostać napisana od podstaw.
Tydzień 9–11 (9–29 listopada)
- Etap D dokumentacji
Tydzień 9 (9–15 listopada)
- Opracowana zostanie teraz wersja OMW 2.0 zgodnie z potrzebami organizacji.
Tydzień 10 (16–22 listopada)
- Dokumentacja strony głównej Open Multilingual Wordnet (OMW) wydaje się być zawiła. W tym tygodniu popracuję nad nią i dodam dodatkowe informacje związane z OMW oraz sprawdzimy, które pozostałe istniejące strony OMW należy uzupełnić.
- Brak stron OMW zostanie poprawiony. W miarę możliwości spróbuję dodać do nich elementy wizualne.
Tydzień 11 (23–29 listopada)
- Projekty GWA pokrywają się, dlatego ten tydzień jest zarezerwowany na zaspokojenie tych pokrywających się potrzeb organizacyjnych oraz na przygotowanie innej dokumentacji.
Etap finalizacji i oceny projektu (30 listopada–5 grudnia)
- W tym tygodniu zajmiemy się korektą dokumentacji pod kątem literówek i błędów.
- Napiszę raport z projektu.
- Poproszę mentorów o sprawdzenie raportu z mojego projektu.
- Sfinalizuję i prześlę raport dotyczący projektu.
- Napiszę i prześlę ocenę moich mentorów oraz moje doświadczenia z Sezonu Dokumentów.
Komunikacja:
Częstotliwość kontaktów z mentorami jest zależna od rozmowy z mentorami. Wolę regularną komunikację – ja sugeruję, by 2 razy w tygodniu przekazywać aktualne informacje i otrzymywać opinie o swojej dotychczasowej pracy. Jest to jednak także elastyczne w zależności od ich preferencji.
Dlaczego ten projekt?
Interesuje mnie lingwistyka. Idea połączenia witryn Wordnet dla wszystkich języków na świecie zaintrygowała mnie do dołączenia do Globalnego Stowarzyszenia Wordnet i udziału w tym projekcie. Koncepcja Open Multilingual Wordnet jest wspaniała, gdy pojedyncze sieci są połączone z sieciami w innych językach, co sprawia, że są one łatwiej dostępne. Open Multilingual Wordnet i jej komponenty mogą być używane, modyfikowane i udostępniane przez dowolną osobę w dowolnym celu. Chociaż GWA ma solidny pomysł i szlachetne zamiary, organizacja nie jest zbyt znana i niedoceniana. Prawdopodobnie jedną z nich jest mała dokumentacja i brak przewodników użytkownika, które pomogłyby przygotować projekt i korzystać z niego. Zdaję sobie sprawę, że projekt Open Multilingual Wordnet może służyć jako pomoc Globalnemu Stowarzyszeniu Wordnet Association i wspólnej społeczności open source.
Przyszłe plany:
Po ukończeniu GSoD 20 będę nadal pomagać w globalnym stowarzyszeniu Wordnet Association w innych projektach. Jeśli będzie taka możliwość, z pewnością wezmę udział w każdej konferencji organizacji.