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 Association
- Technischer Redakteur:
- Yo-Yo-Wu
- Projektname:
- Wordnet-Struktur
- Projektdauer:
- Standardlaufzeit (3 Monate)
Projektbeschreibung
Warum dieses Projekt
Als Technischer Redakteur mit Schwerpunkt Linguistik freue ich mich, ein solches Projekt zu finden, bei dem verschiedene Sprachen mit einem einheitlichen semantisch-konzeptionellen Rahmen verknüpft werden und das in der Praxis für Unternehmen wie Google Translate eingesetzt wird. Ich möchte zu den Dokumenten dieses Projekts beitragen, um es für die Zielgruppe nutzerfreundlicher zu gestalten.
Probleme
Ich habe mir das Originaldokument angesehen und denke, dass wir es verbessern können, indem wir die folgenden Probleme lösen: Es fehlt ein Übersichtsabschnitt am Anfang, um die Grundlagen von Wordnet vorzustellen, was für Anfänger hilfreich ist. Obwohl alle Beziehungen im WordNet in einer einheitlichen Vorlage eingeführt werden, fehlen bei einigen Beziehungen erforderliche Informationen wie Beispiele und Tests, die auf der Princeton Wordnet-Webseite, in den allgemeinen Richtlinien von EuroWordnet und in anderen Ressourcen verfügbar sind. Die kurze Definition und die Definition, das kurze Beispiel und das Beispiel haben kein einheitliches Satzmuster. Da die kurze Definition und das kurze Beispiel die Zusatzinformationen sind, die angezeigt werden, wenn der Mauszeiger des Nutzers auf die jeweilige Beziehung bewegt wird, dienen Definition und Beispiel in erster Linie der Einführung der Beziehung. Sie sollten in einheitlichen, aber anderen Mustern als ihre kurzen Entsprechungen strukturiert sein. Die Tests stammen von EWN, aber der Bedingungsblock sollte vor dem Haupttestkörper platziert werden, da die Nutzenden immer zuerst die Bedingungen betrachten, um zu entscheiden, ob ihre linguistischen Daten den Bedingungen entsprechen, und dann den Test zu absolvieren. Der Testtext ist mit vielen linguistischen Akronymen auch nicht ganz einfach. Der Inhalt des Kommentarabschnitts ist abwechslungsreich, manchmal unterstreicht er einen bestimmten Punkt der Definition oder enthält projektspezifische Details. Ich denke, wir sollten einen Standard für diesen Abschnitt festlegen. Informationen zu bestimmten Projekten in den Abschnitt „Projektspezifische Namen“ zu verschieben, sollte für Nutzer praktischer sein. Im Abschnitt „Projektspezifische Namen“ wird der Beziehungsname in allen Projekten zusammengefasst. Dieser Abschnitt muss überprüft werden, da Abweichungsfehler auftreten. Das Glossar muss direkt mit dem Dokument verknüpft und alle Akronyme und Begriffe hinzugefügt werden, mit denen Sie vielleicht nicht vertraut sind.
Richtlinien
Ich möchte außerdem die folgenden zwei Themen mit dem Projektteam besprechen, bevor ich die Dokumente erstelle. Die erhaltene Schlussfolgerung dient als allgemeine Richtlinie für das gesamte Projekt.
Das Publikum Hier ist ein echtes Beispiel für mich: Obwohl ich einen Abschluss in Linguistik habe, weiß ich beim ersten Lesen des Originaldokuments nicht, was „Synset“ bedeutet. Die Bedeutung von „Synset“ finde ich auf der Princeton Wordnet-Webseite.
Daher müssen wir zuerst die Wissensstruktur der potenziellen Zielgruppe ermitteln. Wenn wir nicht sicher sein können, dass alle Zielgruppenmitglieder über relevantes Wissen verfügen, müssen wir zumindest einen Übersichtsbereich hinzufügen, den Glossar der Begriffe und andere zugehörige Ressourcen verlinken, um sie durch WordNet und die zugehörigen Projekte zu führen. Diese Annahme sollten wir während des gesamten Dokumentationsprozesses im Hinterkopf behalten,
Zur Funktion der Dokumente Meiner Meinung nach sollen die WordNet-Strukturdokumente Nutzern helfen, sich mit allen Beziehungstypen in WordNet vertraut zu machen. Nutzer können Wörter anhand der bereitgestellten Informationen in diese Beziehungen gruppieren. Die Originaldokumente ähneln jedoch eher Auszügen aus wissenschaftlichen Arbeiten. Wenn die Dokumente als akademische Referenz dienen, ist das in Ordnung. Wenn sie jedoch dazu dienen, Nutzer zu leiten, müssen Kompromisse zwischen akademischer und praktischer Anwendbarkeit gefunden werden.
Vorteile
Ich kann Ihnen dabei helfen, die chinesische Version der Dokumente zu übersetzen. Ich habe Erfahrung mit der Übersetzung linguistischer Artikel aus dem Englischen ins Chinesische. Ich kann Ihnen bei der Formatierung der Dokumente helfen. Ich kenne die Grundlagen von HTML/CSS und kann Ihnen dabei helfen, die Webseite der Dokumente ansprechender zu gestalten, z. B. durch das Hinzufügen einer seitlichen Navigationsleiste. Ich kann Ihnen helfen, einige Flussdiagramme mit Visio oder Mermaid zu erstellen, wenn die Nutzer die Beziehungen anhand der Flussdiagramme besser nachvollziehen können.
Meilensteine / Zeit / Ziel
- Woche 1: Ziel, Workflow und Arbeitsplan mit dem Projektteam besprechen und festlegen.
- Woche 2: Entwickeln Sie die Dokumentenstruktur und schreiben Sie den Abschnitt "Übersicht".
- Woche 3 – Woche 4: Schreibe den Teil der konstruktiven Beziehungen.
- Woche 5 bis Woche 6: Verfassen Sie den Abschnitt zu anderen und Domainbeziehungen.
- Woche 7 bis Woche 8: Verfassen Sie den Abschnitt zu Rollenbeziehungen.
- Woche 9: Schreiben Sie die übrigen drei Beziehungen und aktualisieren Sie das Glossar.
- Woche 10: Übersetzen Sie bei Bedarf die chinesische Version.
- Woche 11: Überarbeiten Sie das Format der Dokumente.
- Woche 12: Abschlussprüfung und Zusammenfassung dieses Projekts.