Cette page contient les détails d'un projet de rédaction technique accepté pour Google Season of Docs.
Résumé du projet
- Organisation Open Source:
- Global WordNet
- Rédacteur technique:
- Kumar
- Nom du projet:
- The Open Multilingual WordNet (OMW)
- Durée du projet:
- Durée standard (3 mois)
Project description
Demande de projet:
J'ai été en contact avec des mentors de la Global Wordnet Association et j'ai envoyé une demande d'extraction qu'ils ont jugée favorable. Si possible, je peux consacrer 40 heures (ou plus) par semaine à ce projet. Je maîtrise bien Python, Git, HTML, C++, Java et C. Je suis bilingue et je parle couramment anglais et hindi. J'ai appris le français à l'école et je maîtrise un peu l'allemand. Je suis très enthousiaste à l'idée de contribuer à la Global Wordnet Association dans le cadre de ce projet si je peux travailler avec le plus grand dévouement possible.
État actuel:
La documentation actuelle de Wordnet Open Multilingual est superficielle et incomplète, les guides de l'utilisateur existants manquent de contenu, de graphiques, d'exemples et d'instructions explicites. Il n'existe aucun guide de l'utilisateur pour aider les utilisateurs à effectuer une recherche sur WordNet, ni à lire les pages renvoyées, à installer le logiciel ou à envoyer des commentaires. Il existe de la documentation sur la contribution de WordNet, mais elle n'est ni complète ni claire pour guider quelqu'un sur la façon de rejoindre le Wordnet Open Multilingual. Il n'y a pas de documentation sur la façon d'interagir avec l'index interlingue collaboratif (CILI), il y a une page d'introduction CILI, qui manque d'informations comme pourquoi et comment abandonner et remplacer les concepts, afin d'évaluer les nouveaux candidats. Dans l'ensemble, la documentation actuelle manque de contenu, de clarté, d'exemples et de visuels d'aide.
Plan:
J'ai prévu d'exécuter ce projet en quatre phases. Dans la phase A, je vais documenter un guide pour quelqu'un qui contribue à nouveau WordNet. Au cours de cette phase, je vous expliquerai comment créer un Wordnet bien formaté, comment le mettre en ligne et comment donner un sens aux commentaires. Dans la prochaine phase B, je vais documenter un guide destiné aux personnes qui recherchent le Wordnet (ou la famille de WordNets). Dans cette documentation, je vous expliquerai comment lire les pages renvoyées, comment les télécharger et comment fournir des commentaires. Lors de la phase C, je présenterai un guide d'interaction avec l'index interlingue collaboratif, la procédure d'abandon et de remplacement des concepts. Enfin, l'évaluation des nouveaux candidats sera documentée à la phase C. Dans la phase D, je remplirai la documentation de Wordnet Open Multilingual, et améliorerai la documentation existante de ce projet autre que la documentation abordée dans les phases A, B et C. Étant donné qu'il existe des chevauchements entre les projets de GWA, la phase D sera également consacrée aux exigences organisationnelles. J'ai prévu d'allouer les semaines 1, 2 et 3 à la phase A, les semaines 4, 5 et 6 à la phase B, les semaines 7, 8 et 9 pour la phase C, et les semaines 10 et 11 à la phase D.
Objectifs du projet:
1) Analyser la documentation existante et déterminer quelle section doit être améliorée.
2) Reconstruction de la structure de la documentation existante.
3) Documenter un guide pour quelqu'un qui crée un nouveau WordNet.
4) Documenter un guide pour les internautes qui recherchent sur WordNet.
5) Documenter un guide d'interaction avec l'index interlingue collaboratif
6) Ajouter des exemples et des visuels à la documentation.
7) Remplir les pages existantes lorsque la documentation semble superficielle.
Vos trajets :
Phase d'adhésion à une communauté: du 17 août au 13 septembre.
- Pendant cette période, je vais interagir avec la communauté et mieux la connaître.
- Mettez en place un canal de communication.
- Définissez une heure de communication.
- Affiner les objectifs et définir les attentes des deux côtés.
Phase de développement des documents (du 14 septembre au 30 novembre)
- Je vais travailler en étroite collaboration avec mes mentors et terminer mon projet dans cette phase selon les plans hebdomadaires.
- répondre aux enquêtes des administrateurs du programme Google ;
Semaines 1-3 (14-27 septembre)
- Phase A de documentation
Semaine 1 (14-20 septembre)
- La documentation d'un guide pour quelqu'un qui crée un nouveau wordnet va commencer.
- Cette semaine, je vais vous parler de la documentation sur la création de Wordnets bien formatés.
- Des instructions claires pour convertir le Wordnet de l'utilisateur en définition de type de document LMF public (DTD) seront documentées.
- Il présente également les outils de conversion.
Semaine 2 (21-27 septembre)
- Cette semaine, je vais créer la documentation sur la façon dont on téléchargera un Wordnet (après la conversion en définition du type de document Wordnet LMF) sur OMW.
- La documentation existante est superficielle (mais exacte) je vais la remplir et y ajouter des exemples.
Semaine 3 (28 septembre - 4 octobre)
- Cette semaine sera utilisée pour la documentation sur la façon de donner un sens au feedback.
- Cette documentation doit être rédigée de A à Z, car il n'existe aucune documentation à ce sujet.
Semaines 4-6 (5-25 octobre)
- Phase B de documentation
Semaine 4 (5-11 octobre)
- Cette semaine, je vais commencer à rédiger un guide destiné aux personnes qui recherchent le wordnet (ou la famille de Wordnets).
- Cette semaine, je rédigerai une documentation expliquant comment lire les pages renvoyées.
Semaine 5 (12-18 octobre)
- Cette semaine, je vais vous expliquer comment procéder au téléchargement.
- Il n'existe aucune documentation à ce sujet. Vous devez l'écrire à partir de zéro.
Semaine 6 (19-25 octobre)
- Cette semaine, je vais documenter comment fournir des commentaires à l'organisation.
- Comme il n'existe aucune documentation antérieure à partir de laquelle se référer, cela va également être écrit à partir de zéro.
Semaines 6-9 (26 octobre-15 novembre)
- Phase de documentation – C
Semaine 7 (26 octobre-1er novembre)
- Cette semaine, je commencerai à documenter un guide sur l'interaction avec l'index interlingue collaboratif (CILI).
- Cette semaine, je vous expliquerai comment et pourquoi abandonner et remplacer les concepts.
Semaine 8 (2-8 novembre)
- Cette semaine, je vais documenter des informations supplémentaires sur CILI et écrire des instructions sur la façon de télécharger CILI et de répondre aux exigences organisationnelles dans la documentation CILI. Cette documentation doit être écrite de zéro.
Semaines 9-11 (9-29 novembre)
- Phase D de documentation
Semaine 9 (9-15 novembre)
- OMW 2.0 sera développé maintenant, selon les besoins organisationnels.
Semaine 10 (16-22 novembre)
- La documentation de la page d'accueil Open Multilingual Wordnet (OMW) semblait superficielle. Cette semaine, je vais y travailler et ajouter les informations supplémentaires relatives à OMW, et j'examinerai les autres pages OMW existantes qui doivent être renseignées.
- Il manque des pages OMW et j'essaierai d'y ajouter des éléments visuels dans la mesure du possible.
Semaine 11 (23-29 novembre)
- En raison des chevauchements des projets GWA, cette semaine est réservée à la réponse à ces besoins organisationnels en conflit, ainsi qu'à d'autres documents divers.
Finalisation et phase d’évaluation du projet (30 novembre – 5 décembre)
- Cette semaine sera consacrée à la correction des fautes de frappe et des erreurs dans la documentation.
- Je rédigerai mon rapport de projet.
- Je demanderai à mes mentors d’examiner le rapport de mon projet.
- Je vais finaliser et soumettre mon rapport de projet.
- Je rédigerai et proposerai une évaluation de mes mentors et de mon expérience de Season of Docs.
Communication:
La fréquence des contacts dépendra des échanges avec les mentors. Je préfère une communication régulière - je suggère deux fois par semaine de faire le point sur le travail effectué jusqu'à présent et de recevoir des commentaires. Cependant, cette approche est également flexible en fonction de leurs préférences.
Pourquoi ce projet ?
Je m'intéresse à la linguistique, et l'idée de connecter des réseaux de mots pour toutes les langues du monde m'a intriguée à rejoindre la Global Wordnet Association et à contribuer à ce projet. Le concept de réseau de mots clés multilingues ouvert est admirable : des réseaux de mots individuels sont reliés à des réseaux de mots dans d'autres langues, ce qui les rend plus facilement accessibles. Le WordNet Open Multilingual et ses composants peuvent être utilisés, modifiés et partagés librement par quiconque, à n'importe quelle fin. Bien que la GWA ait une idée solide et une noble intention, l'organisation n'est pas très renommée et est sous-estimée. Probablement l'une des raisons est la documentation superficielle et le manque de guides de l'utilisateur pour aider à la contribution et à l'utiliser. J'ai perçu que le projet Open Multilingual Wordnet était quelque chose dans lequel je pouvais contribuer pour aider la Global Wordnet Association et la communauté open source en commun.
Projets futurs:
Après avoir terminé le cours GSoD 20, je continuerai à contribuer à la Global Wordnet Association dans d'autres projets. Je participerai certainement à toutes les conférences de l'organisation si j'en ai l'occasion.