Projekt der Global Wordnet Association

Auf dieser Seite finden Sie die Details zu einem Projekt für technisches Schreiben, das für Google Season of Docs angenommen wurde.

Projektzusammenfassung

Open-Source-Organisation:
Global Wordnet
Technischer Redakteur:
Kumar
Projektname:
Open Multilingual Wordnet (OMW)
Projektdauer:
Standardlänge (3 Monate)

Projektbeschreibung

Projektanfrage:

Ich bin mit den Mentoren der Global Wordnet Association in Kontakt und habe eine Pull-Anfrage eingereicht, die von ihnen positiv bewertet wurde. Wenn ich die Chance bekomme, kann ich 40 Stunden oder mehr pro Woche für dieses Projekt aufwenden. Ich verfüge über gute Kenntnisse in Python, Git, HTML, C++, Java und C. Ich bin zweisprachig und spreche fließend Englisch und Hindi. In der Schule habe ich Französisch gelernt und kann auch ein bisschen Deutsch. Ich würde mich sehr freuen, durch dieses Projekt einen Beitrag zur Global Wordnet Association zu leisten. Wenn ich die Chance dazu bekomme, werde ich mit größtem Engagement arbeiten.

Aktueller Status:

Die aktuelle Open Multilingual Wordnet-Dokumentation ist oberflächlich und unvollständige Nutzerhandbücher enthalten keine Inhalte, Grafiken, Beispiele und expliziten Anweisungen. Es gibt kein Nutzerhandbuch, das Nutzer bei der Suche im Wordnet unterstützt, Informationen zum Lesen der zurückgegebenen Seiten, zur Installation und zum Senden von Feedback gibt. Es gibt zwar eine Dokumentation zum Einreichen neuer Wordnets, diese ist jedoch weder vollständig noch klar genug, um jemandem zu zeigen, wie er sich dem Open Multilingual Wordnet anschließen kann. Es gibt keine Dokumentation zur Interaktion mit dem Collaborative Interlingual Index (CILI). Es gibt eine Einführungsseite für CILI, die jedoch Informationen darüber fehlt, warum und wie Konzepte eingestellt und ersetzt werden und wie neue Kandidaten beurteilt werden. Insgesamt fehlt es den aktuellen Dokumentationen an Inhalt, Klarheit, Beispielen und visuellen Hilfsmitteln.

Preismodell:

Ich habe geplant, dieses Projekt in vier Phasen durchzuführen. In Phase A erstelle ich eine Anleitung für Nutzer, die neue WordNet-Einträge beisteuern. In dieser Phase geht es darum, wie man ein gut formatiertes WordNet erstellt, wie man es hochlädt und wie man das Feedback interpretiert. In der nächsten Phase B erstelle ich eine Anleitung für Nutzer, die im WordNet (oder in einer WordNet-Familie) suchen. In dieser Dokumentation erkläre ich, wie die zurückgegebenen Seiten gelesen, heruntergeladen und Feedback gegeben werden kann. In Phase C erstelle ich eine Anleitung für die Interaktion mit dem Collaborative Interlingual Index, erkläre, wie Konzepte eingestellt und ersetzt werden, und beschreibe, wie neue Kandidaten beurteilt werden. In Phase D fülle ich die Dokumentation des Open Multilingual Wordnet aus und verbessere die vorhandene Dokumentation dieses Projekts, die nicht in Phasen A, B und C behandelt wurde. Da sich die Projekte von GWA überschneiden, wird Phase D auch den organisatorischen Anforderungen gewidmet. Ich habe Wochen 1,2 und 3 für Phase A, Wochen 4,5 und 6 für Phase B, Wochen 7,8 und 9 für Phase C und Wochen 10 und 11 für Phase D geplant.

Projektziele:

1) Die vorhandene Dokumentation analysieren und feststellen, welcher Abschnitt verbessert werden muss.

2) Rekonstruktion der Struktur der vorhandenen Dokumentation.

3) Die Dokumentation eines Leitfadens für Personen, die neues Wordnet beitragen.

4) Die Dokumentation eines Leitfadens für Personen, die im Wordnet suchen.

5) Eine Anleitung für die Interaktion mit dem Collaborative Interlingual Index dokumentieren.

6) Der Dokumentation Beispiele und visuelle Elemente hinzufügen.

7) Vorhandene Seiten füllen, auf denen die Dokumentation oberflächlich erscheint

Zeitplan:

  • Phase des Community-Aufbaus: 17. August bis 13. September

    • In dieser Zeit werde ich mit der Community interagieren und sie besser kennenlernen.
    • Richten Sie einen Kommunikationskanal ein.
    • Legen Sie einen Termin für die Kommunikation fest.
    • Ziele verfeinern und Erwartungen auf beiden Seiten definieren.

  • Phase der Dokumententwicklung (14. September bis 30. November)

    • Ich werde eng mit meinen Mentoren zusammenarbeiten und mein Projekt in dieser Phase gemäß den wöchentlichen Plänen abschließen.
    • Sie füllen eine Umfrage der Google-Programmadministratoren aus.

  • Woche 1–3 (14.–27. September)

    • Dokumentationsphase-A

  • Woche 1 (14.–20. September)

    • Die Dokumentation für einen Leitfaden für Personen, die neue WordNet-Einträge beisteuern, wird erstellt.
    • Diese Woche erstelle ich die Dokumentation zum Erstellen eines gut formatierten Wordnets.
    • Es wird eine eindeutige Anweisung zum Konvertieren des WordNets des Nutzers in die öffentliche Wordnet-LMF-Dokumenttypdefinition (DTD) dokumentiert.
    • Conversion-Tools werden darin ebenfalls behandelt.

  • Woche 2 (21.–27. September)

    • Diese Woche werde ich die Dokumentation dazu erstellen, wie man sein WordNet (nach der Umwandlung in die WordNet-LMF-Dokumenttypdefinition) in die OMW hochlädt.
    • Die vorhandene Dokumentation ist oberflächlich (aber korrekt). Ich werde sie ergänzen und Beispiele hinzufügen.

  • Woche 3 (28. September bis 4. Oktober)

    • Diese Woche wird dazu genutzt, zu dokumentieren, wie Sie das Feedback auswerten.
    • Diese Dokumentation muss von Grund auf neu erstellt werden, da es keine vorhandene Dokumentation zu diesem Thema gibt.

  • Woche 4–6 (5.–25. Oktober)

    • Dokumentationsphase B

  • Woche 4 (5. bis 11. Oktober)

    • Diese Woche beginne ich mit der Dokumentation eines Leitfadens für Nutzer, die im WordNet (oder in einer WordNet-Familie) suchen.
    • Diese Woche werde ich eine Dokumentation dazu schreiben, wie die zurückgegebenen Seiten gelesen werden.

  • Woche 5 (12. bis 18. Oktober)

    • Diese Woche zeige ich euch, wie ihr die Dateien herunterladen könnt.
    • Es gibt keine vorhandene Dokumentation dafür. Sie muss von Grund auf neu geschrieben werden.

  • Woche 6 (19. bis 25. Oktober)

    • Diese Woche werde ich dokumentieren, wie ich der Organisation Feedback geben kann.
    • Da es keine vorherige Dokumentation gibt, auf die Bezug genommen werden kann, wird dies ebenfalls von Grund auf neu geschrieben.

  • Woche 6–9 (26. Oktober bis 15. November)

    • Dokumentationsphase C

  • Woche 7 (26. Oktober bis 1. November)

    • Diese Woche beginne ich mit der Dokumentation einer Anleitung für die Interaktion mit dem Collaborative Interlingual Index (CILI).
    • Diese Woche erkläre ich, wie und warum Konzepte eingestellt und ersetzt werden sollten.

  • Woche 8 (2. bis 8. November)

    • Diese Woche werde ich zusätzliche Informationen zu CILI dokumentieren und eine Anleitung zum Herunterladen von CILI und zum Erfüllen der organisatorischen Anforderungen in der CILI-Dokumentation schreiben. Diese Dokumentation muss von Grund auf neu geschrieben werden.

  • Woche 9–11 (9. bis 29. November)

    • Dokumentationsphase D

  • Woche 9 (9. bis 15. November)

    • OMW 2.0 wird jetzt gemäß den Anforderungen der Organisation entwickelt.

  • Woche 10 (16.–22. November)

    • Die Dokumentation der Open Multilingual Wordnet-Homepage (OMW) schien oberflächlich zu sein. Diese Woche werde ich daran arbeiten und die zusätzlichen Informationen zu OMW hinzufügen, und ich werde mir ansehen, welche anderen bestehenden OMW-Seiten befüllt werden müssen.
    • Fehlende Seiten mit offenen Marktplätzen werden verbessert und ich werde nach Möglichkeit visuelle Elemente hinzufügen.

  • Woche 11 (23. November bis 29. November)

    • Da es bei GWA-Projekten Überschneidungen gibt, ist diese Woche dem Erfüllen dieser sich überschneidenden organisatorischen Anforderungen und anderer Dokumentationen vorbehalten.

  • Projektabschluss- und Bewertungsphase (30. November bis 5. Dezember)

    • Diese Woche wird die Dokumentation auf Tippfehler und Fehler überprüft.
    • Ich werde meinen Projektbericht schreiben.
    • Ich werde meine Mentoren bitten, meinen Projektbericht zu überprüfen.
    • Ich werde meinen Projektbericht fertigstellen und einreichen.
    • Ich werde eine Bewertung meiner Mentoren und meiner Erfahrungen mit der Season of Docs verfassen und abgeben.

Kommunikation:

Die Häufigkeit des Kontakts hängt von einer Unterhaltung mit den Mentoren ab. Ich bevorzuge eine regelmäßige Kommunikation. Mein Vorschlag ist, zweimal pro Woche ein Update zu geben und Feedback zur bisherigen Arbeit zu erhalten. Je nach Präferenz der Nutzer ist dies jedoch auch flexibel.

Warum dieses Projekt?

Ich interessiere mich für Linguistik und die Idee, Wordnets für alle Sprachen der Welt zu verbinden, hat mich dazu veranlasst, der Global Wordnet Association beizutreten und zu diesem Projekt beizutragen. Das Konzept von Open Multilingual Wordnet ist bewundernswert, da einzelne Wordnets mit Wordnets in anderen Sprachen verknüpft sind, was diese Wordnets leichter zugänglich macht. Open Multilingual Wordnet und seine Komponenten können von allen kostenlos verwendet, geändert und zu beliebigen Zwecken weitergegeben werden. Obwohl GWA eine gute Idee und gute Absichten hat, ist die Organisation nicht sehr bekannt und wird unterschätzt. Einer der Gründe dafür ist wahrscheinlich die mangelhafte Dokumentation und das Fehlen von Anleitungen, die bei der Erstellung und Verwendung von Inhalten helfen. Ich habe erkannt, dass ich mit dem Open Multilingual Wordnet-Projekt der Global Wordnet Association und der Open-Source-Community gemeinsam helfen kann.

Zukünftige Pläne:

Nach Abschluss der GSoD 20 werde ich auch in anderen Projekten für die Global Wordnet Association beitragen. Ich werde auf jeden Fall an jeder Konferenz der Organisation teilnehmen, wenn ich die Gelegenheit dazu bekomme.