Allgemeines

Aufbau & Verwendung Doku

Die Dokumentation von Vote folgt einem klaren roten Faden, um selbst die komplexesten Funktionen jedem verständlich rüberbringen zu können. Um den roten Faden folgen und verstehen zu können, um bspw. zu wissen, welche Teilabschnitte irrelevant sind und welche für das Gesamtverständnis von Bedeutung sind, dient dieser Abschnitt. Die Dokumentation besitzt dabei mehrere Teilabschnitte:

• Allgemeines Allgemeine Anleitung zur Einordnung der Informationen und Verwendung der Dokumentation. Vote an sich ist nicht komplex, viele der Komponenten sind allerdings nicht mehr trivial, daher könnte ein direktes Springen zu den inhaltlichen Punkten Probleme bereiten, sofern der Kontext nicht bekannt ist.

• Nutzer Durch die Erstellung von Votes werden Nutzer-Profile für die Ersteller angelegt. Welche Möglichkeiten der Konfiguration die Nutzer besitzen wird hier genauer erläutert

• Vote Objekt Einführung des Vote Objekts mit sämtlichen Komponenten, Einstellungen, Konfigurationsmöglichkeiten, Funktionen etc.

• Clients Diese Bereiche bauen auf das Vote-Objekt auf und setzen dieses Wissen vorraus. Sie beinhalten Informationen, wie Vote konkret in den einzelnen Komponenten verwendet werden kann und welche Besonderheiten es bei den versch. Clients gibt.

• API Die Dokumentation der API ist ausgelagert auf OpenAPI Doku und ist dort auch nur in englisch verfügbar.

• Änderungshistorie Im letzten Teil der Dokumentation ist die Änderungshistorie zu finden. Dort sind alle Änderungen in den einzelnen Versionen zu finden. Die Highlights sind dabei auch auf der Startseite des Guides zu finden.

Wichtig Sofern einfache Einführungsvideos benötigt werden, um ein erstes Verständnis zu bekommen, schau am besten mal bei Demos vorbei.

Alle Komponenten der Dokumentation und der Demos können mit Hilfe der Suche durchsucht werden. Die API ist allerdings hiervon ausgenommen, da diese für sich selbst steht. Die Dokumentation dient hierbei als Grundlage für alle Komponenten von Vote und wird daher an verschiedenen Stellen bei der Verwendung der Guides verlinked, um einen nahtlosen Übergang zwischen Verwendung von Vote dem Nachlesen von verschiedenen Informationen bieten zu können.

Verwendbarkeit Vote

Die vollumfängliche Verwendung ist aktuell noch Mitarbeitern der Deutschen Telekom sowie allen Tochtergesellschaften vorbehalten, hierzu gehören bspw. die Erstellung von neuen Votes. Um allerdings Mitarbeitern und auch Externen (Kunden, Entwickler, ...) die Teilnahme von Votes zu ermöglichen, ist Vote ansonsten für jeden zugänglich und verwendbar. Die Identifizierung von internen Mitarbeitern geschieht dabei auf Basis der IP-Adresse, die bei Anfragen kurz mit den freigegebenen IP-Adressen verglichen wird. Daher werden Mitarbeiter an Firmenlaptops nicht als solche erkannt, sofern diese bspw. keinen VPN etc. verwenden. Da bestimmte interne Funktionen unseren Mitarbeitern auch auf anderen Geräten - ggf. nicht gemanagte Laptops - zu ermöglichen gibt es die Möglichkeit über den Access-Key/API-Key den Zugriff von außerhalb des Telekom Netzes zu erhalten. Ein sog. Access-Key kann dabei auf der Dashboardseite des einzelnen Nutzers, nachdem dieser mind. 1 Vote erstellt hat, generiert werden. Ansonsten unterliegt die Verwendung von Vote sowie allen Komponenten den Nutzungsbedingungen.

Begriffe

Um nachfolgend gezielter Funktionen und Komponenten von Vote einführen zu können, werden anschließend die grundlegenden Begriffe von Vote eingeführt:

• Vote: Hierbei handelt es sich sowohl um das System, als auch um ein erstelltes Hauptobjekt innerhalb des Systems, wie bspw. eine Umfrage, Befragung, Q&A, …

• QuestionBlock: Basiselemente einer Vote stellen die Frageblöcke dar, die die Fragen/Objekte innerhalb einer Vote nach semantischer Zugehörigkeit clustern. Sie bilden eine logische Klammer und können dem Nutzer zusätzliche Informationen (Titel, Beschreibung,…) liefern, um die darunterliegenden Fragen besser beantworten zu können.

• Question: Das atomare Element einer Vote ist eine Frage, die je nach Modul unterschiedlich repräsentiert werden kann. Daher kann eine Frage u.a. eine MultipleChoice, FreeText, WordCloud, Q&A sein und je nach Einstellung der jeweiligen Frage sich unterschiedlich in diversen Situation verhalten. Die eigentliche Verwen-dung einer Frage hängt allerdings von den Einstellungen der übergeordneten Vote ab.

• Modul: Ein Modul ist eine logische Gruppierung von Funktionen und Einstellungen in Vote. Vote besitzt aktuell zwei Module: Abstimmung/Befragung (Survey) und Interaktive Tools (interactive), die jeweils für unterschiedliche Anwendungsfälle genutzt und unterschiedliche Regularien einhalten müssen

• User: Vote besitzt kein Accountsystem. Um allerdings Anwendern trotzdem die Möglichkeit zu bieten, eine Übersicht über alle ihrer Votes zu haben, werden für jeden Anwender User angelegt. Durch eine anonyme Kennung, die lediglich über eine Mail angefragt werden kann, kann ein Nutzer anschließend in Form eines Dashboards eine Übersicht über seine Votes erhalten.

• AnonymUser: Für jeden Teilnehmer wird ein anonymer User angelegt, der für die Teilnahme an einer Vote und für die Speicherung von Einstellungen des Nutzers (Alias & Team) verwendet wird. Sofern der Nutzer keine benutzerbezogenen Informationen in den Alias einträgt, ist eine Zuordnung von Teilnehmer zu dem AnonymUser unmöglich.

• Answer & React: Die eigentliche Beantwortung einer Frage wird durch eine Answer (Antwort) dargestellt. Eine Reaktion darauf, bspw. Kommentar oder Daumen hoch, wird durch einen React im System abgebildet.

• Session: Hierbei handelt es sich um einen Kontext im System, der entweder den aktuellen Kontext eines Nutzers oder den anzunehmenden Kontext einer Einladung repräsentiert. Durch die Verwendung einer Client & Serverseitigen Authentisierung/Autorisierung kann auf Serverseite der Kontext eines Nutzers/einer Einladung nachträglich noch verändert werden, falls bspw. eine Einladung fehlerhaft verschickt wurde.

• Invite: Einladung zu einer Vote für einen bestimmten Teilnehmer in Form einer Mail (Default) oder einer der Integrationen

Systemfunktionalitäten und Bestandteile

Vote besitzt neben den Funktionalitäten einzelner Votes (Teilnahme, Analysis, etc.) auch Systemfunktionalitäten, die für den Gesamtbetrieb notwendig sind. Nachfolgend sollen diese Systemfunktionalitäten genauer beschrieben werden:

• Sprachen: Oberflächen (Web/Integrationen) in deutsch und englisch, je nach Einstellung in Vote oder Browser/Client.

• Themes: Oberflächdesigns (Web) je nach Präferenz des Nutzers (Dark/Bright Theme).

• Pro/Easy Mode: (Nur Web) Nutzer können einstellen, wie viele Informationen/Funktionen er von Vote sehen will, um ggf. nicht überfordert zu werden.

• Reserver ID: (Aktuell nur API) Reservierung von Vote-IDs, um bspw. zu bestimmten Events bestimmte Codes anzubieten. (Nicht Zahlen-Codes müssen vorher bei System Administratoren angefragt werden)

• Template Validation: (Aktuell nur API) Validieren von Vote Templates mit anschließender Rückmeldung zur Überarbeitung.

• OpenAPI Dokumentation: Ausführliche Dokumentation der REST-API von Vote mit der Möglichkeit direkt Operationen auszuführen.

• Dashboards: Übersicht aller Votes einer bestimmten Person, ohne automatischer Authorisierung der Votes.

• IFrame: (Noch nicht verfügbar) Unterstützung von IFrames zur Einbindung von Vote auf anderen Seiten.

• MOTD: Message of the day – Möglichkeit aktuelle Informationen über das System an die Nutzer zu be-kommen.

• Reminder: Erinnerungen für Nutzer, wenn bspw. Vote in naher Zukunft gelöscht wird.

• Translate: (Aktuell nur API) Da Vote-Objekte in unterschiedlichen Sprachen angeboten werden können, wird das Telekom Translationtool für eine automatische Übersetzung verwendet, sofern dies vom Nutzer gewünscht ist.

• Run: (Aktuell nur API) Durchlauf einer Vote, zu dem die jeweiligen Antworten in dem Zeitraum zugeordnet werden.

Module

Wie einem der letzten Abschnitte beschrieben stellen Module logische Gruppierungen von Einstellungen und Funktionen in Vote dar. Durch die verschiedenen Anwendungsfälle der einzelnen Gruppen können unterschiedliche Regularien angewendet und strikter zwischen den Bereichen unterschieden werden. Beispielsweise muss bei Abstimmungen und Befragungen die Anonymität gegeben sein, bei einer Q&A im interaktiven Bereich wäre allerdings eine strikte Anonymität kontraproduktiv, wodurch eine optionale personenbezogene Bindung erlaubt werden muss.

• Survey: Anonyme Umfrage von Nutzern zu einem bestimmten Thema mit späterer Auswertung. (u.a. KBV Evaluation, Befragung)

• Interaktive Tools: (Aktuell nur API) Tools zur Unterstützung der agilen Arbeit, bspw. Q&A, Planning Poker, Meeting Finder … (u.a. KBV digitale Zusammenarbeit)