Cette page contient les détails d'un projet de rédaction technique accepté pour la Google Season of Docs.
Résumé du projet
- Organisation Open Source:
- Global Wordnet Association
- Rédacteur technique:
- Yoyo Wu
- Nom du projet:
- Structure Wordnet
- Durée du projet:
- Durée standard (trois mois)
Project description
Pourquoi ce projet ?
En tant que rédactrice technique spécialisée en linguistique, je suis ravie de découvrir un projet de ce type, qui vise à relier différentes langues à l'aide d'un cadre sémantique-conceptuel unifié, et qui a été appliqué à des entreprises réelles telles que Google Traduction. J'aimerais contribuer aux documents de ce projet afin de le rendre plus facile à utiliser pour le public.
Problèmes
J'ai examiné le document original et je pense que nous pouvons l'améliorer en résolvant les problèmes ci-dessous : Manque de section "Présentation" au début pour présenter les bases de Wordnet, qui seront utiles aux novices. Bien que toutes les relations dans Wordnet soient déployées dans un modèle unifié, certaines d'entre elles manquent d'informations nécessaires, comme les exemples et les tests, disponibles sur le site Web du Princeton Wordnet, les consignes générales d'EuroWordnet et d'autres ressources. Les modèles de phrases de la définition courte et de la définition, de l'exemple court et de l'exemple ne sont pas unifiés. En effet, la définition courte et l'exemple court sont des accroches lorsque la souris de l'utilisateur pointe sur la relation en question. La définition et l'exemple ont pour rôle principal de présenter la relation. Ils doivent donc être structurés selon des modèles unifiés, mais différents de ceux de leurs versions courtes. Les tests proviennent d'EWN, mais le bloc "conditions" doit être placé avant le corps du test principal, car les utilisateurs examinent toujours les conditions en premier pour déterminer si leurs données linguistiques y correspondent, puis pour effectuer le test. Le corps du test n'est pas non plus très simple, avec de nombreux acronymes linguistiques. Le contenu de la section Commentaires est diversifié. Parfois, elle souligne un point particulier de la définition, parfois elle indique des détails spécifiques au projet. Je pense que nous devrions définir une norme pour cette section. Déplacer les informations sur des projets spécifiques vers la section "Noms spécifiques au projet" devrait être plus pratique pour les utilisateurs. La section "Noms spécifiques au projet" résume le nom de la relation dans tous les projets. Cette section doit être examinée, car des erreurs de non-concordance se produisent. Vous devez établir un lien direct entre le glossaire et le document, et ajouter tous les acronymes et les termes que le débutant peut ne pas connaître.
Consignes
Je voudrais également discuter des deux sujets ci-dessous avec l'équipe du projet avant de rédiger les documents. Les conclusions reçues serviront de lignes directrices générales pour l'ensemble du projet.
À propos de l'audience Voici un exemple concret de moi-même. Bien que je sois spécialisé en linguistique, lorsque je suis tombé sur le document d'origine, je ne savais pas ce que "synset" signifiait. C'est sur la page Web de Princeton Wordnet que j'ai trouvé la signification de "synset".
Nous devons donc d'abord comprendre la structure des connaissances de l'audience potentielle. Si nous ne pouvons pas garantir que tout le public dispose des connaissances pertinentes, nous devons au moins ajouter une section de présentation, lier le glossaire des termes et d'autres ressources associées pour les guider dans Wordnet et les projets associés. Nous devons toujours garder cette hypothèse à l'esprit tout au long du processus de documentation.
À propos de la fonction des documents Selon moi, l'objectif des documents sur la structure de WordNet est d'aider les utilisateurs à se familiariser avec tous les types de relations dans WordNet. Les utilisateurs peuvent regrouper des mots dans ces relations en fonction des informations fournies. Cependant, les documents originaux ressemblent davantage à des extraits d'articles universitaires. Si les documents servent de référence universitaire, ce n'est pas grave, mais s'ils servent à guider les utilisateurs, il doit y avoir des compromis entre l'enseignement et l'utilité.
Avantages
Je peux vous aider à traduire la version chinoise des documents. J'ai de l'expérience dans la traduction d'articles linguistiques de l'anglais vers le chinois. Je peux vous aider à mettre en forme les documents. Je connais les bases du HTML/CSS et je peux vous aider à améliorer l'apparence de la page Web des documents, par exemple en ajoutant une barre de navigation latérale. Je peux vous aider à créer des organigrammes à l'aide de Visio ou de Mermaid si ces éléments peuvent aider les utilisateurs à mieux comprendre les relations.
Étapes / Durée / Objectif
- Semaine 1: discutez et définissez l'objectif, le flux de travail et le plan de travail avec l'équipe de projet.
- Semaine 2: Finalisez le plan des documents et rédigez la section "Présentation".
- Semaine 3 – Semaine 4: rédigez la partie relative aux relations constitutives.
- Semaines 5 à 6: rédigez la partie sur les relations "Autre" et "Domaine".
- Semaine 7 à 8: rédigez la partie "Relations de rôle".
- Semaine 9: écrivez les trois relations restantes et mettez à jour le glossaire.
- Semaine 10: Traduire la version en chinois, si nécessaire
- Semaine 11: réviser le format des documents.
- Semaine 12: dernière vérification et résumer ce projet.