Diese Seite enthält die Details zu einem Projekt für technisches Schreiben, das für die Google-Produktsaison von Google Docs akzeptiert wurde.
Projektzusammenfassung
- Open-Source-Organisation:
- Globale Wordnet-Vereinigung
- Technischer Redakteur:
- Yoyo Wu
- Projektname:
- WordNet-Struktur
- Projektdauer:
- Standarddauer (3 Monate)
Projektbeschreibung
Warum dieses Projekt?
Als technische Redakteurin mit dem Hauptfach Linguistik freue ich mich über ein solches Projekt, bei dem verschiedene Sprachen mit einem einheitlichen semantisch-konzeptionellen Rahmen verknüpft werden können. Das Projekt wurde auch auf reale Unternehmen wie Google Übersetzer angewendet. Ich möchte zu den Dokumenten dieses Projekts beitragen, um es nutzerfreundlicher zu machen.
Probleme
Ich habe mir das ursprüngliche Dokument angesehen und denke, wir können es verbessern, indem wir folgende Probleme lösen: Es fehlt der Abschnitt „Übersicht“ am Anfang, in dem die Grundlagen von Wordnet vorgestellt werden, die für Einsteiger hilfreich sein könnten. Obwohl alle Beziehungen im Wordnet in einer einheitlichen Vorlage eingeführt werden, fehlen bei einigen Beziehungen notwendige Informationen wie Beispiele und Tests, die auf der Princeton Wordnet-Webseite, den allgemeinen Richtlinien von EuroWordnet und anderen Ressourcen zu finden sind. Bei den Beispielen für die Kurzform und die Definition, die Kurzform und das Beispiel fehlt ein einheitliches Satzmuster, da die Kurzdefinition und das Beispiel mit Kurzfassung die Callouts sind, wenn der Nutzer den Mauszeiger auf eine bestimmte Beziehung bewegt. Definition und Beispiel dienen der Hauptrolle zur Einführung der Beziehung. Sie sollten einheitlich strukturiert sein, aber von den kurzen Mustern abweichen. Die Tests stammen aus dem EWN, aber der Bedingungsblock sollte vor dem Haupttesttext platziert werden, da Nutzer immer zuerst die Bedingungen betrachten, um zu entscheiden, ob ihre linguistischen Daten den Bedingungen entsprechen, und dann den Test durchführen. Außerdem ist der Testtext mit vielen linguistischen Akronymen nicht besonders einfach. Der Inhalt des Abschnitts „Kommentare“ ist vielfältig. Manchmal wird ein bestimmter Punkt der Definition betont, manchmal werden projektspezifische Details erwähnt. Ich denke, wir sollten für diesen Abschnitt einen Standard festlegen. Das Verschieben von Informationen zu bestimmten Projekten in den Abschnitt „Projektspezifische Namen“ sollte für Nutzer einfacher sein. Im Abschnitt „Projektspezifische Namen“ wird der Beziehungsname in allen Projekten zusammengefasst. Dieser Abschnitt muss überprüft werden, da Fehler aufgrund von Abweichungen auftreten. Es ist erforderlich, das Glossar direkt mit dem Dokument zu verlinken und alle Abkürzungen und Begriffe hinzuzufügen, die Einsteiger möglicherweise noch nicht vertraut sind.
Richtlinien
Ich möchte außerdem die folgenden zwei Themen mit dem Projektteam besprechen, bevor ich die Dokumente entwerfe. Die erhaltenen Ergebnisse dienen als allgemeine Richtlinien für das gesamte Projekt.
Über das Publikum Hier ist ein echtes Beispiel von mir. Obwohl ich ein linguistisches Hauptfach bin, weiß ich nicht, was „Synset“ bedeutet, als ich zum ersten Mal auf das Originaldokument stoße. Auf der Webseite von Princeton Wordnet finde ich die Bedeutung von Synset.
Zuerst müssen wir also die Wissensstruktur der potenziellen Zielgruppe ermitteln. Wenn wir nicht sicherstellen können, dass alle Teilnehmer über das relevante Wissen verfügen, müssen wir zumindest einen Abschnitt mit der Übersicht hinzufügen, einen Link zum Glossar und andere verwandte Ressourcen einfügen, um sie durch Wordnet und die damit verbundenen Projekte zu führen. Wir sollten diese Annahme während des gesamten Dokumentationsprozesses immer im Hinterkopf behalten,
Über die Funktion der Dokumente Nach meinem Verständnis besteht das Ziel von Wordnet-Struktur-Dokumenten darin, Nutzern zu helfen, sich mit allen Beziehungstypen in Wordnet vertraut zu machen, und Nutzer können Wörter basierend auf den bereitgestellten Informationen in diesen Beziehungen gruppieren. Die Originaldokumente sehen jedoch eher wie Auszüge wissenschaftlicher Arbeiten aus. Wenn die Dokumente als akademischer Referenz dienen, ist das in Ordnung, aber wenn sie dem Zweck dienen, Nutzer anleiten zu können, muss es Kompromisse zwischen Wissenschaft und Nutzen geben.
Vorteile
Ich kann Ihnen beim Übersetzen der chinesischen Version der Dokumente helfen. Ich habe Erfahrung mit der Übersetzung linguistischer Dokumente vom Englischen ins Chinesische. Ich kann Ihnen beim Formatieren der Dokumente helfen, kenne die Grundlagen von HTML/CSS und kann helfen, die Google Docs-Webseite besser aussehen zu lassen, z. B. durch das Hinzufügen einer seitlichen Navigationsleiste. Ich kann Flussdiagramme mit Visio oder Meerjungfrau zeichnen, wenn die Flussdiagramme den Nutzenden helfen, die Beziehungen besser zu verstehen.
Meilensteine / Zeit / Ziel
- Woche 1: Das Ziel, den Arbeitsablauf und den Arbeitsplan mit dem Projektteam besprechen und festlegen.
- Woche 2: Legen Sie die Dokumentenstruktur fest und schreiben Sie den Abschnitt „Übersicht“.
- Woche 3 – Woche 4: Schreibe den Teil „Konstituierende Beziehungen“.
- Woche 5 – Woche 6: Schreibe den Teil „Sonstige“ und „Domainbeziehungen“.
- Woche 7–Woche 8: Schreibe den Teil mit den Rollenbeziehungen.
- Woche 9: Schreiben Sie die verbleibenden drei Beziehungen und aktualisieren Sie das Glossar.
- Woche 10: Bei Bedarf die chinesische Version übersetzen
- Woche 11: Überarbeiten Sie das Format der Dokumente.
- Woche 12: Abschlussprüfung und Zusammenfassung dieses Projekts.