Kolibri-Projekt

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:

Kolibri

Technischer Redakteur:

Daniela V

Projektname:

Kolibri Content-Workflows

Projektdauer:

Langfristig (5 Monate)

Projektbeschreibung

Der folgende Vorschlag wurde durch die Durchführung von Recherchen und Gesprächen mit den Mentoren von Kolibri erstellt. Die Gespräche mit den Mentoren haben mir geholfen, die User Personas zu entwickeln, die ich unten erläutere. Außerdem habe ich durch meine Diskussionen eine Idee für ein Tutorial-Repository bzw. eine Landingpage entwickelt, damit die Nutzer selbst entscheiden können, welche Anleitung sie sich für ihre Anforderungen ansehen möchten.

Übersicht

Dieser Vorschlag stellt eine Lösung zur Steuerung der verschiedenen User Journeys vor, die eine Person durch den Import von Inhalten von ihrem Computer in Kolibri Studio und dann von Kolibri Studio zu Kolibri führen kann. Ich schlage vor, ein zentrales Repository für Anleitungen zu erstellen. Der Nutzer greift über eine Landingpage auf diese Anleitungen zu. Auf der Landingpage finden Sie eine Tabelle mit Links zu den einzelnen Workflowanleitungen. Außerdem wird angegeben, für welche Art von Nutzer die Anleitung hilfreich sein könnte. Auf diese Weise werden die Anleitungen stärker auf die Bedürfnisse und Fähigkeiten der Nutzenden zugeschnitten. Ein Workflow (z. B. INSTALL- IMPORT) wird in mehreren Lektionen demonstriert. Jede Lektion enthält ein Video. Die Videos zeigen einen kleinen Teil des Workflows und veranschaulichen einzelne Konzepte dazu, wie diese Workflows Kolibri-Anwendungen verbinden.

Hauptziele

1. Erstellen Sie eine Landingpage für Anleitungen, die Nutzern bei der Entscheidung hilft, welcher Workflow für sie am besten geeignet ist. Diese Landingpage wird auf der Plattform „Lesen Sie die Dokumente“ gehostet.

2. Erstellen Sie einzelne Lektionen für die Komponenten der einzelnen Workflows und ergänzen Sie schwierige Lektionen durch Übungen.

3. Erstellen Sie interaktive Videos für jeden Workflow.

Projekttools

Die Arbeit erfolgt mithilfe einer Screencast-Software. Ich habe Erfahrung mit Camtasia, aber auch mit weniger teurer Software und Freeware gearbeitet. Das hier verlinkte Beispielvideo (https://youtu.be/DkMP_VdGslU) wurde mit Flashback von Blueberry Software erstellt, für das ich derzeit eine Lizenz habe. Ich erstelle Untertitel mit YouTube. Die Anleitungsseiten werden auf der Website „Read the Docs“ von Kolibri gehostet. Die Entwürfe werden in Google Docs fertiggestellt und ich kann dir dabei helfen, Textdateien in Markdown oder reStructuredText für das Endprodukt zu konvertieren.

Spielplan

Dieses Projekt folgt den langfristigen Projektrichtlinien (insgesamt 26 Wochen, vom 2. September 2019 bis zum 28. Februar 2020). Ich werde etwa 10 Stunden pro Woche damit verbringen, die unten genannten Ziele zu erreichen. Zusätzlich zu diesen Zielen werde ich während dieser Zeit an Mentoring-Meetings teilnehmen und kommunizieren, falls erforderlich. Ich werde mit den beratenden Personen zusammenarbeiten, um den besten Zeitpunkt dafür zu bestimmen. Der Zeitplan ist in der Regel in vier Wochen gegliedert, wobei ich mehrere Videos, Anleitungsseiten und Übungen erstelle.

Hinweis :Dieser Zeitplan ist flexibel und berücksichtigt, dass sich organisatorische Anforderungen ändern können. Die langen Zeiträume bieten Flexibilität und die Möglichkeit, den Fokus nach Bedarf zu verlegen.

Woche 1 und 2

Zielvorhaben:

• Richten Sie ein privates Gerät mit allen Websites oder Konten ein, die für den Zugriff auf Informationen benötigt werden.
• Beginnen Sie, eine Struktur und detailliertere Wireframes für die Landingpage zu entwickeln.
• Sprich mit den Mentoren über den Stil der Videos und entwickle eine Vorlage für den Videostartbildschirm, Füllmusik für Titel und Abspanne sowie zusätzliche Informationen, die enthalten sein sollten.
• Überprüfen Sie die aktuelle Dokumentations- und Dokumentationsstruktur, um Links zur Verwendung in zusätzlichen Ressourcen und Anleitungen zu extrahieren.

Woche 3 bis 6 (Stufe 1 – Anleitungen für Anfänger)

Zielvorhaben:

• Entwickeln Sie erste Inhalte und Lektionen für den INSTALL-IMPORT-/Level 1-Workflow. Erstellen Sie ein Video für den Download, die Installation, die Konfiguration und den Import. Da die INSTALL-IMPORT-Funktionen die Grundlage vieler anderer und am häufigsten verwendeter Workflows sind, wird ein großer Teil der Zeit darauf verwendet werden, diese Anleitungen und Lektionen abzuschließen.
• Konzentrieren Sie sich auf die IMPORT-Standorttypen und entwickeln Sie eine Grafik, die dem Nutzer zeigt, wo er Inhalte (öffentliche Kanäle, die in Kolibri Studio vorhanden sind) für die Landingpage erwerben können.
• Entwickeln Sie zusätzliche Videos und Inhalte für Erweiterungen von INSTALL-IMPORT (UPDATE-Kanal). Diese Erweiterungen können auch in Form zusätzlicher Ressourcen oder Links zu vorhandener Dokumentation erfolgen.
• Arbeite an Untertiteln für alle Videos.
• „Testen“ Sie Videos und bitten Sie die verfügbaren Ressourcen zur Nutzungsfreundlichkeit um Feedback. Dazu gehört auch, die Vorlage für Videos noch einmal zu überprüfen und sie für zukünftige Videos zu erarbeiten.

7. bis 10. Woche (Level 2 – Content Uploader)

Zielvorhaben:

• Konzentrieren Sie sich auf Lektionen und Workflow-Videos für die Persona des Studio-Uploaders.
• Vollständige Dokumentation und Lektionen zu UPLOAD-PUBLISH-IMPORT.
• Erstelle Untertitel für alle Videos.

Weeks Eleven bis 1ourteen (Level 3 – Content „Remixer“ und Editor)

Zielvorhaben:

• Konzentriere dich auf die folgenden Workflows und erstelle Tutorial-/Lektionsinhalte: UPLOAD-EDIT-PUBLISH-UPDATE und EDIT-PUBLISH-UPDATE.
• Erstelle Untertitel für Videos.

Woche 15 bis 18

Zielvorhaben:

• Wie während meiner Forschung zu diesem Vorschlag vermittelt, haben Arbeitsabläufe mit Ricecooker eine niedrigere Priorität (CHEFDEV-Typ). Je nach Zeitplan und Zeitplan könnte ich diese Zeit nutzen, um eine allgemeine Anleitung zu erstellen, die sich auf die vorhandene Dokumentation für Ricecooker bezieht.

Woche 19 bis 22

Zielvorhaben:

• Schätzen Sie alle Lücken ein und testen Sie den aktuellen Ablauf aller Anleitungen.
• Arbeite an der Fertigstellung der Landingpage und beginne, die Videos miteinander zu verknüpfen.
• In Google Docs erstellte Seitenentwürfe in Markdown oder reStructuredText umwandeln, wie mit den beratenden Personen besprochen

Wochen 23 bis 25

Zielvorhaben:

• Erledigen Sie je nach Zeit alle endgültigen Arbeiten in Tutorials mit niedriger Priorität für Fortgeschrittene.
• Last minute: Bearbeitung der Google Docs-Seite, Dateitests, Grammatik-/Rechtschreibprüfung
• QA für Links in Videos oder auf anderen Seiten

Woche 26

Letzte Woche für lang andauernde Projekte. Ich werde mit beratenden Personen zusammenarbeiten, um die Liefergegenstände des Projekts abzuschließen und alle erforderlichen endgültigen Google-Dokumente zu vervollständigen.

Komponenten einer Anleitung

Landingpage für Anleitung

Die Nutzer greifen auf eine Anleitungs-Landingpage auf der Website „Read the Docs“ von Kolibri zu, die einen kurzen Überblick über die verschiedenen Anleitungen enthält, die für Inhalts-Workflows angeboten werden. Auf dieser Seite erhalten Sie einen kurzen Überblick über das Kolibri-Ökosystem und eine grafische Darstellung der verschiedenen Workflows. Auf diese Weise kann der Nutzer die Art von Workflow sehen, der seinen Anforderungen – technisch und für den Lehrplan der Organisation – am besten entspricht. Die Nutzer werden die Optionen, die ihnen in Kolibri und Kolibri Studio zur Verfügung stehen, besser verstehen.

Anleitungs- und Lektionsseiten

Jede Anleitungsstartseite bietet eine Einführung in das Tutorial, das aus mehreren Lektionen besteht, gefolgt von einigen Zielen der Nutzer. Tutorials veranschaulichen einen gesamten Workflow und bestehen aus einzelnen Lektionen. Jede Lektion enthält ein Video. Die Videos decken einen einzelnen Teil eines Gesamtkonzepts ab. Jede Lektion wird auf einer eigenen Seite auf der übergeordneten Seite des Tutorial-Workflows gespeichert. Die Lektionsseiten enthalten Schaltflächen, über die der Nutzer zur vorherigen oder nächsten Lektion innerhalb des Tutorials wechseln kann. Sehr komplexe Konzepte können Übungsaktivitäten umfassen.

Videos und Struktur

In den Videos wird nur ein Konzept beschrieben. Videos geben eine Richtung vor, während diese Aktion auf dem Bildschirm ausgeführt wird. Ein Beispielvideo finden Sie hier: https://youtu.be/DkMP_VdGslU. In diesem Beispielvideo wird gezeigt, wie Sie den Einrichtungsassistenten verwenden.

Hinweis :Dieses Video ist zwar ein Beispiel für vorhandene Inhalte, es soll aber zeigen, wie sich mit Erweiterungen mit Zusatzinformationen und Cursorhervorhebungen ein einheitlicher Stil für das Video erstellen lässt.

Im Video werden Zusatzinformationen und ein hervorgehobener Cursor verwendet, um den Nutzer durch die einzelnen Schritte dieses Konzepts zu führen. Die Videos werden auf YouTube gehostet. Wenn sie auf YouTube gehostet werden, werden Untertitel automatisch generiert. Dann bearbeite ich die Untertitel auf Rechtschreibung, Grammatik und Zeichensetzung. Diese Untertitel können dann für Übersetzungen in Amara oder ein anderes Übersetzungstool exportiert werden.

Die Videos haben einen einheitlichen Titelbildschirm, über den ich mich in den ersten Wochen mit den beratenden Personen unterhalten werde. Ich werde auch einen einheitlichen Stil für Zusatzinformationen verwenden (Pfeile, Cursor-Hervorhebung, Kästchen), über den ich in den ersten Wochen gemeinsam mit den Mentoren entscheiden werde.

Beispielstrukturen

Der einfachste Workflow, INSTALL-IMPORT, ist ein ganzes Tutorial. Dieses Tutorial enthält zwei mögliche Lektionen mit einem Video:

• Kolibri-Einrichtung herunterladen, installieren und einrichten
• Content in Kolibri Studio importieren: Hinweis: Dieses Video wird von anderen Workflows bezeichnet.

Für eine fortgeschrittenere Anleitung sind mehrere untergeordnete Lektionen mit mehreren Videos erforderlich. Der Workflow UPLOAD-EDIT-PUBLISH-UPDATE folgt der folgenden Struktur.

Hinweis: Wenn sich dieser Workflow außerhalb der Kolibri Studio-Seiten befindet und die erste Einführung von Kolibri Studio erfolgt, finden Sie auf der Einführungsseite für diese Videos Links zur Anmeldung und zum Erstellen eines Studio-Kontos. Untergeordnete Lektionen sind einzelne Seiten. Aufgrund der Komplexität dieses Workflows enthält jede Unterstunde daher mehrere Videos.

Lektion 1 – Inhalte hochladen und Kanäle in Kolibri Studio erstellen

Nutzerziele: Am Ende dieser Lektion wissen Sie, wie Sie die folgenden Aktionen ausführen:

• Erstellen Sie in Kolibri Studio Kanäle zur Verwendung in Kolibri. Du weißt, wie du die geheimen Tokens deines Kanals verwendest, um deinen Inhaltskanal in Kolibri zu importieren.
• Du kannst einen Kanal erstellen, indem du Inhalte aus vorhandenen öffentlichen Kanälen in die Studio-Mediathek importierst.
• Erstelle einen Kanal, indem du Inhalte von deinem Computer hochlädst.

Videos in untergeordneten Lektionen:

• Teil 1 – Erstelle deine eigenen Kanäle in Kolibri Studio und importiere Inhalte aus vorhandenen öffentlichen Kanälen (Khan Academy, PHET usw.): Video 1: Öffentliche Inhaltskanäle (Öffentliche Kanäle in Kolibri Studio ansehen) Video 2 – Kanal erstellen Video 3 – Inhalte aus bestehenden Kanälen importieren Video 4 – Kanal veröffentlichen und geheimes Token erhalten Video 5 – Kanal mit dem geheimen Token in Kolibri importieren
• Teil 2: Inhalte in eigenen Dokumenten hochladen: Video 1 – Dateien aus eigenen Dokumenten hochladen Video 2: Eigene Übungen erstellen

Lektion 2: Erweiterte Bearbeitung von Kanälen in Kolibri Studio

Nutzerziele: Am Ende dieser Lektion wissen Sie, wie Sie die folgenden Aktionen ausführen:

• Inhaltskanäle in Kolibri Studio bearbeiten
• Inhaltskanäle in Kolibri Studio verwalten

Videos in untergeordneten Lektionen:

• Unterlektion 1: Inhalte durch Hinzufügen von Übungen bearbeiten, Ordnerstruktur neu anordnen und Optionen für die Zusammenarbeit (1 Video)
• Teil 2: Andere Funktionen verwenden, beispielsweise das Löschen/Verschieben von Inhalten (1 Video)

Lektion 3 – Kolibri Studio-Kanäle zur Verwendung in Kolibri veröffentlichen und Kanäle aktualisieren

Nutzerziele: Am Ende dieser Lektion wissen Sie, wie Sie die folgenden Aktionen ausführen:

• Einen Kanal in Kolibri Studio veröffentlichen und erneut veröffentlichen, nachdem neue Inhalte hinzugefügt wurden
• Kanal aktualisieren
• Erwerben Sie ein Kanaltoken, um es in Kolibri zu importieren (über einen Link zum vorherigen Video in Lektion 1, in dem diese Aktion behandelt wird).

Videos in untergeordneten Lektionen:

• Teil 1: Veröffentlichen von Updates auf einem Kanal

  Video 1: Kanal neu veröffentlichen Video 2: Kanal auf Kolibri aktualisieren, nachdem zusätzliche Inhalte hinzugefügt wurden