Ta strona zawiera szczegóły projektu technicznego do pisania w sezonie Dokumentów Google.
Podsumowanie projektu
- Organizacja open source
- Global Wordnet Association
- Pisarz techniczny:
- Yoyo Wu
- Nazwa projektu:
- Struktura Wordnet
- Długość projektu:
- Standardowa długość (3 miesiące)
Opis projektu
Dlaczego ten projekt
Jako autorka tekstów technicznych specjalizująca się w językoznawstwie cieszę się, że znalazłam taki projekt, który łączy różne języki w ramach jednolitej struktury semantycznej i koncepcyjnej, a na dodatek został zastosowany w praktyce biznesowej, np. w Tłumaczu Google. Chciałabym wnieść swój wkład w dokumentację tego projektu, tak aby był on bardziej przyjazny dla odbiorców.
Problemy
Po zapoznaniu się z oryginalnym dokumentem uważam, że możemy go ulepszyć, rozwiązując poniższe problemy: Brak sekcji Omówienie w celu wprowadzenia podstawowych informacji o Wordnetzie, które będzie przydatne dla początkujących. Chociaż wszystkie relacje w WordNet są wdrażane w ramach ujednoliconego szablonu, niektóre z nich nie zawierają niezbędnych informacji, takich jak przykłady i testy, które są rozpowszechniane na stronie Princeton Wordnet, w ogólnych wytycznych EuroWordnet i innych zasobach. Definicja krótka i Definicja, przykład krótki i Przykład nie mają ujednoliconego wzorca zdania, ponieważ definicja krótka i przykład krótki są opisami wyświetlanymi, gdy użytkownik najedzie kursorem na daną relację, a definicja i przykład służą głównie do przedstawienia relacji. Należy je uporządkować w ujednolicony sposób, ale w innym niż w przypadku definicji krótkiej i przykładu krótkiego. Testy pochodzą z EWN, ale blok warunków powinien znajdować się przed głównym testem, ponieważ użytkownicy zawsze najpierw sprawdzają warunki, aby zdecydować, czy ich dane językowe są zgodne z tymi warunkami, a potem wykonują test. Treść testu nie jest też tak prosta, ponieważ zawiera wiele skrótów językowych. Zawartość sekcji Komentarze jest zróżnicowana: czasami podkreśla znaczenie pewnego punktu definicji, a czasem nawet podaje szczegóły związane z projektem. Moim zdaniem powinniśmy ustanowić standard dla tej sekcji. Przeniesienie informacji o konkretnych projektach do sekcji „Nazwy związane z poszczególnymi projektami” powinno być wygodniejsze dla użytkowników. Sekcja Nazwy specyficzne dla projektu zawiera podsumowanie nazwy relacji we wszystkich projektach. Należy ją sprawdzić, ponieważ występują w niej błędy niezgodności. Musisz dodać link do glosariusza bezpośrednio do dokumentu oraz dodać wszystkie akronimy i terminy, których nie znasz dla nowicjuszy.
Wytyczne
Przed opracowaniem dokumentów chciałbym przedyskutować z zespołem projektowym dwa poniższe zagadnienia. Otrzymane wnioski posłużą za ogólne wytyczne dla całego projektu.
Informacje o odbiorcach: Oto prawdziwy przykład ze mną. Jestem lingwistą, ale gdy po raz pierwszy natknąłem się na oryginalny dokument, nie wiedziałem, co oznacza „synset”. Dopiero na stronie Princeton Wordnet dowiedziałem się, co to jest.
Najpierw musimy więc określić strukturę wiedzy potencjalnych odbiorców. Jeśli nie możemy zagwarantować, że wszyscy odbiorcy mają odpowiednią wiedzę, musimy przynajmniej dodać sekcję Omówienie, dodać link do Glosariusza terminów i inne powiązane zasoby, aby pomóc im w zapoznaniu się z WordNet i powiązanymi z nim projektami. Należy zawsze pamiętać o tym założeniu podczas całego procesu dokumentowania.
Informacje o funkcji dokumentów Zgodnie z moimi zrozumieniem celem dokumentów struktury Wordnet jest pomaganie użytkownikom w poznawaniu wszystkich typów relacji w Wordnet i grupowanie słów w te relacje na podstawie podawanych informacji. Oryginalne dokumenty wyglądają jednak bardziej jak fragmenty prac naukowych. Jeśli dokumenty mają charakter naukowy, jest to dopuszczalne, ale jeśli mają służyć jako przewodnik dla użytkowników, należy znaleźć kompromis między wartością naukową a użytecznością.
Zalety
Mogę pomóc w przetłumaczeniu dokumentów na język chiński. Mam doświadczenie w tłumaczeniu prac naukowych z języka angielskiego na chiński. Mogę pomóc w formatowaniu dokumentów. Znam podstawy HTML/CSS i mogę pomóc w ulepszeniu strony z dokumentami, na przykład dodając boczny pasek nawigacyjny. Mogę pomóc w rysowaniu schematów blokowych za pomocą Visio lub Syreny, jeśli mogą one pomóc użytkownikom lepiej zrozumieć zależności między nimi.
Główne etapy / Czas / Cel
- Tydzień 1. Omów z zespołem projektu cel, przepływ pracy i plan pracy.
- Tydzień 2.: Uporządkuj konspekt dokumentów i napisz sekcję Omówienie.
- Tydzień 3–4. Napisz część dotyczącą relacji konstytutywnych.
- Tydzień 5–6. Napisz część dotyczącą innych relacji i relacji z domeną.
- Tydzień 7–8: napisz część o relacjach ról.
- Tydzień 9. Napisz pozostałe 3 relacje i zaktualizuj słowniczek.
- Tydzień 10. W razie potrzeby przetłumacz wersję chińską.
- Tydzień 11: sprawdzenie formatu dokumentów.
- Tydzień 12: Ostatnia kontrola i podsumowanie projektu.