Die Spannweite der Qualität von Anleitungen ist groß.

Bedienungs- und Betriebsanleitungen, die „pauschal“ für alle Zielgruppen gleich erstellt werden sind weder nutzerfreundlich noch hilfreich. Leider allerdings auch nicht selten. Eine gute Technische Kommunikation unterstützt den Benutzer dabei seine Aufgaben mit dem Produkt effektiv zu erledigen. Sie trägt maßgeblich zur Effizienz bei der Erledigung der Aufgaben bei, ist leicht zu finden, einfach zu lesen und vor allem hilfreich!

 

Eine fundierte Analyse des IST-Zustands und des Bedarfs an Informationsprodukten für Ihre Nutzer bilden das Fundament für eine maßgeschneiderte User-Assistance.

Warum wir der richtige Partner sind

Unsere Experten für User-Experience, Informationsmanagement und Technische Redaktion definieren gemeinsam mit Ihnen die Ziele, planen die Maßnahmen und sorgen durch iterative Abstimmungszyklen dafür, in der Spur zu bleiben. Ist die Hilfe erstellt, testen wir diese für Ihre Anwender in unserem Usability-„Labor“ auf Effektivität, Effizienz und Zufriedenstellung und justieren gegebenenfalls nach.

Das Ergebnis sind nützliche Informationsprodukte, die die Qualität Ihrer Marke widerspiegeln und sich bestens in Ihre Corporate Identity integrieren.

Planen

In enger Zusammenarbeit erfassen wir mit Ihnen den Bedarf an Informationsprodukten für Ihre Nutzer. In unserem standardisierten Prozess erarbeiten wir für Sie einen Projekt- und Dokumentationsplan und bieten Ihnen durch unsere iterative Arbeitsweise zu jeder Zeit den Überblick zum Projektfortschritt.

Neben der Analyse der Zielgruppen und Informationsarten beleuchten wir für Sie auch die Anforderungen an Grafiken, Illustrationen, Änderungsfrequenz, Variantenvielfalt und die Mehrsprachigkeit Ihrer Produkte. Diese gründliche Planung erspart Ihnen kostspielige und zeitraubende Änderungsprozesse im späteren Verlauf und stellt eine wichtige Entscheidungsgrundlage für die spätere Toolauswahl dar.

Unsere Leistungen:

  • Dokumentationsplan
  • Projektmanagement für Technische Kommunikation
  • Outsourcing-Konzept
  • Interim-Projektmanagement
  • Consulting
Projektmanagement Teamwork
Recherche Flipchart Brainstorming

Recherche

Hochwertige Inhalte lassen sich nicht ohne tiefgreifendes Verständnis des Produkts und der Anforderungen und Bedürfnisse an die Informationen zu dem Produkt erstellen. Bei der Produkt- und Anforderungsrecherche klären wir mit Ihren Fachexperten die Anforderungen an die zu erstellenden Inhalte, die Ausgabeformate, Sprachstile und Nutzungskontexte des Produkts.

Unsere erfahrenen Technischen Redakteure mit Branchen-Know-how sind in der Lage, sich in die Rolle Ihrer Benutzer zu versetzen und das Produkt aus deren Blickwinkel zu erlernen. Wenn wir verstanden haben, wie und unter welchen Bedingungen der Anwender das Produkt nutzt, wird klar welche Inhalte zu einem zufriedenstellenden Umgang mit dem Produkt beitragen.

Unsere Leistungen:

  • User-Research
  • Bestandsanalyse
  • Zielgruppenanalyse
  • Use-Case-/Track-Analyse
  • Zieldefinition
  • Umfeldanalyse

Erstellen / Prüfen

Gute Informationsprodukte setzen voraus, dass gute Inhalte darin existieren. Auf Basis der zuvor erarbeiteten Dokumentationspläne und der Recherche-Ergebnisse erstellen wir mit unseren Technischen Redakteuren modulare Informationsbausteine (Topics), die später zu Ihren Informationsprodukten geschnürt werden. Unser höchstes Ziel ist es, komplexe Sachverhalte vereinfacht darzustellen und so zu einem besseren Produktverständnis beizutragen.

In unserem Qualitätssicherungsprozess prüfen wir die von uns erstellten Inhalte auf sprachliche und grammatikalische Richtigkeit, erarbeiten bei Bedarf eine einheitliche Terminologie und entwerfen für Sie einen Inhaltsleitfaden, der als Basis für eine konsistente Sprache in Ihren Dokumenten dient und damit die Qualität Ihrer Marke widerspiegelt.

Unsere Leistungen:

  • Informationsarchitektur
  • Content-Strategien
  • Bedienungs- und Betriebsanleitungen
  • Installationsanleitungen
  • API-Dokumentation
  • Lern- und Trainingsmaterialien
Erstellen Prüfen
Usability Test

Publikation / Usability Test

Eine wichtige Eigenschaft Technischer Informationen im Zeitalter der Digitalisierung ist die schnelle Verfügbarkeit, eine leichte Navigation und unkomplizierte Auffindbarkeit der Dokumentationen. Je nach Anforderungen sollten diese dabei online und offline verfügbar sein, für mobile Endgeräte wie Smartphones oder Tablets optimiert und gleichzeitig auf Laptops oder stationären PCs einsetzbar sein. Unsere Fachexperten für das Cross-Media-Publishing erarbeiten gerne Ihren idealen Weg, um diese Standards zu erfüllen, bereiten Ihren Content für das Single-Source-Publishing vor und unterstützen Sie bei der Entwicklung entsprechender Layouts für Ihre Informationsprodukte.

Im Sinne des kontinuierlichen Verbesserungsprozesses werden diese Informationsprodukte anschließend einem Test auf „Praxistauglichkeit“ unterzogen. Im Mittelpunkt des Tests steht die Anleitung und wie diese den Nutzer bei der Aufgabenlösung unterstützt.

Unsere Usability-Tester besprechen mit Ihnen Art und Umfang eines individuell auf Ihre Informationsprodukte und Zielgruppen abgestimmten Tests. Der Anwendertest bzw. Praxistest Ihrer Dokumentation liefert Ihnen als Ergebnis ein umfassendes Qualitätsbild des getesteten Informationsproduktes und deckt Potentiale für bessere Usability in weiteren Anleitungen auf.

Unsere Leistungen:

  • Online- und Print-Anleitungen
  • Responsive User-Assistance-Konzepte
  • Online-Hilfen
  • Usability-Testing
  • User-Experience-Testing

Warum sich unsere Kunden für uns entscheiden

  • 1.

    Unser Team von Technischen Redakteuren ist spezialisiert darauf, sich schnell in neue Sachverhalte einzuarbeiten. Für Sie bringen wir beste Kenntnisse in Recherche, Standardisierungsmethoden und Content-Management-Systemen für die Technische Kommunikation mit.

  • 2.

    Wir sind schreibbegeisterte ITler, verstehen die Anforderungen aus der Branche und sind stark vertraut mit der Softwareentwicklung, agilen Entwicklungsmethoden, IT-Tools und IT-Security. Unsere Kunden setzen auf die langjährige Erfahrung von Systemintegratoren, Softwareentwicklern, Sprachtalenten, Übersetzungsmanagern, Terminologieexperten und Projektleitern.

  • 3.

    Durch unsere Hands-on-Mentalität sind wir agil in der Herangehensweise und dadurch schnell sowie reaktionsfreudig. Durch exakte Schätzungen der Aufwände und standardisierte Prozesse planen wir genau und bieten iterative Updates zu den Zwischenständen im Projekt.

  • 4.

    Wir erfassen systematisch die Anforderungen Ihrer Anwender und entwickeln in enger Zusammenarbeit mit Ihnen begeisternde Content-, User-Interface- und User-Experience-Strategien. Setzen Sie von User-Research bis Interaction-Design auf das volle Know-how-Spektrum unserer Spezialisten für begeisternde User-Experience und spiegeln Sie dadurch die Qualität Ihres Unternehmens innerhalb Ihrer Produkte wider.

Projektmanagement für Informationsprodukte

Um eine Technische Dokumentation erstellen zu können und Ihren Zielgruppen dadurch bessere Informationsprodukte bereitzustellen, ist es wichtig, saubere Prozesse und ein durchdachtes Projektmanagement in der Abteilung für Ihre Technischen Redakteure zu etablieren. Gerne erarbeiten wir mit Ihrem frisch gegründeten Informationsarchitekten-Team ein Konzept für eine effektive und effiziente Zusammenarbeit. Ganz nach Ihren Vorstellungen übernehmen wir dabei die Rolle als Interim-Redaktionsleitung oder stellen Ihnen unsere Experten als Consultants zur Seite.

Gemeinsam entwickeln wir Workflows für Sie, die zum Team passen und die Informationsqualität verbessern. Wir unterstützen Sie in agiler und partnerschaftlicher Zusammenarbeit in Zeiten hoher Arbeitsaufkommen durch spezialisierte Technische Redakteure, die Ihre Produkte kennen, das redaktionelle Know-how mitbringen und Ihre Nutzer verstehen.

Starten Sie bereits vorab in Eigenregie

Sie möchten erste Schritte für die Organisation Ihrer Technischen Kommunikation selbst angehen? Für Sie haben wir einige Basics rund um das Thema Informationsprodukte für den Einstieg zusammengefasst.

Dokumentieren ist eine Daueraufgabe. Diese muss folglich immer ausreichend und parallel zum eigentlichen Entwicklungsprozess der Software erfolgen und nicht erst knapp und unvollständig nach Abschluss des Projekts.

Sorgen Sie dafür, dass die Dokumentation Bestandteil der eigentlichen Entwicklungsarbeit wird. Setzen Sie auf unsere Experten um Ihren Dokumentationsprozess in die Entwicklungsarbeit zu integrieren, einzelne Informationsprodukte zu übernehmen oder für den nötigen Feinschliff Ihrer selbst erstellten Dokumentationen zu sorgen.

Ein Technischer Redakteur wurde dafür ausgebildet. Ihm bereitet diese Arbeit Spaß. Ganz im Gegensatz zu den meisten Entwicklern und anderen IT-Mitarbeitern. Profitieren Sie von unserer Begeisterung in der Informationserfassung.

Wir folgen dem Ansatz des Single-Source-Publishing. Layout-neutral erstellte Informationsprodukte sind in alle Medien und Formate publizierbar und können je nach Anforderungen des Anwenders, des eingesetzten Mediums und des Formats unterschiedlich dargestellt werden.

Weiter haben Sie mit dieser Arbeitsweise den Vorteil, dass Sie sich voll und ganz auf den Inhalt Ihrer Texte konzentrieren können und Duplikate sowie dadurch entstehende veraltete Informationssilos vermeiden.

Doch wie fängt man überhaupt mit dem Dokumentieren an? Unsere Checkliste liefert Ihnen dazu einen ersten Einstieg:

  • Teamverantwortlichkeiten klären.
  • Projektanforderungen vermitteln.
  • Zielgruppen beschreiben.
  • Informationsprodukte festlegen.
  • Ausgabemedium und -format pro Informationsprodukt definieren.
  • Informationsrecherche betreiben.
  • Inhaltsverzeichnis festlegen.
  • Inhalte erstellen.
  • Qualität der Inhalte überprüfen (sprachlich, fachlich, technisch).
  • Inhalte publizieren.
  • Inhalte pflegen.

Aus vielen Gesprächen kristallisieren sich immer wieder dieselben Fragen heraus. Finden auch Sie sich in einer der Situationen wieder?

  • Wir haben das Gefühl, wir dokumentieren nicht das richtige.
  • Unsere Dokumentation wird nicht gelesen und wir beschreiben viel zu viel.
  • Wir kommen mit dem Erstellen der Dokumentation nicht hinterher.

Um den Ursachen der oben beschriebenen Situationen auf den Zahn zu fühlen, Konzepte zu entwickeln, die den Ursachen engegenwirken und herauszufinden, ob sich das Dokumentieren auch lohnt, haben wir einen Tipp für Sie:

Dokumentieren Sie immer dann, wenn es:

  • um Wissen geht, das langfristig interessant ist und
  • um Wissen geht, das für viele Personen interessant ist.

Sie sollten nicht dokumentieren, wenn:

  • das Wissen morgen bereits veraltet ist und Ihr Produkt nur sekundär betrifft.
    -> Diese Informationen haben keine hohe Priorität.
  • das Wissen nur eine Person interessiert.
    -> Gibt es keine breitere Zielgruppe für die Informationen, sind diese nicht primär für Informationsprodukte relevant.

Ist Ihre Dokumentation nicht aktuell, hat sie keinen Mehrwert. Ist das Vertrauen in die Korrektheit und die Aktualität Ihrer Informationen dahin, wird es schwer, dieses Vertrauen beim Leser wieder aufzubauen.

Ihre Software- bzw. IT-Dokumentation sollte daher folgende Kriterien erfüllen:

  • exakt im Wortlaut.
  • verlässlich im Bezug auf die Aktualität.
  • synchron zum ausgelieferten Entwicklungsstand.
  • kollaborativ, denn sie fördert den Wissensaustausch zwischen Personen.
  • erkenntnisreich, weil durchdacht und in mehreren Iterationen abgestimmt.
  • zugänglich, durchsuchbar und hürdenfrei.

Sprechen Sie mit uns, wenn es um die Frage geht, was in Ihrem konkreten Fall nun dokumentiert werden soll.

Unsere standardisierte Planung hilft dabei, die IT-Prozesse, das Produkt, den IST-Zustand und den Bedarf an die interne IT-Dokumentation zu klären. Diese Recherche erfolgt in partnerschaftlicher Zusammenarbeit mit Ihren Fachabteilungen.

Wir entwickeln ein Konzept, das nicht nur dabei hilft, das IT-System zu beschreiben, sondern auch ermöglicht, die Funktionsweisen und Aufgaben der Nutzer des IT-Systems innerhalb von ganzheitlichen Geschäftsprozessen zu betrachten und zu dokumentieren. Für die Nutzer-Recherche bedienen wir uns unserer Cross-Domain-Expertise in der User-Experience und wenden die dortigen Research-Methoden in der Praxis an.

Nach Klärung der Frage, welche Informationsprodukte von wem und in welchem Zeitintervall gepflegt werden, sind ein perfekt funktionierendes Dateiablagesystem und eine saubere Versionskontrolle essentielle Pfeiler eines guten Dokumentationskonzepts. Das Ergebnis unserer Arbeit ist Ihr Dokumentationsleitfaden, der die zu entstehenden Dokumente und den Weg zum Ziel standardisiert. Ein Dokumentationsflow, der wie maßgeschneidert sitzt.

Bei Bedarf beraten wir Sie gerne auch bei der Abwägung, der Einführung und Pflege eines Content-Management-Systems.

Unsere Tipps für gute Softwarekommunikation

Für das Dokumentieren von Software für externe Anwender sollten Sie sich in jedem Fall auch mit den allgemeinen Regeln für die Erstellung Technischer Dokumentationen auskennen. In der Praxis erleben wir immer wieder, dass aus Zeit- und Kostengründen an den falschen Stellen gespart wird. Anbei unsere Top Ten Regeln zur Orientierung, um nicht nach kürzester Zeit den Überblick über Ihre Dokumentation zu verlieren.

Ohne gut durchdachtes Konzept, saubere Planung, Abstimmung mit dem Auftraggeber und Wissen über die Zielgruppe können Sie keine qualitativ gute Dokumentation erstellen und versinken früher oder später im Chaos. Setzen Sie daher auf einen guten Dokumentationsplan. Folgendes sollte dieser in jedem Fall enthalten:

  • Wer sind die Stakeholder?
  • Wer sind die Zielgruppen?
  • Welchen Informationsbedarf haben die Zielgruppen?
  • Welche Inhaltsstruktur wird für die Informationsprodukte benötigt?
  • Wie sieht das Inhaltsverzeichnis aus?
  • In welcher Produktlebensphase wird das Informationsprodukt benötigt?
  • Wer erstellt das Informationsprodukt?
  • Wie ist der Projektablaufplan bis zum fertigen Produkt?
  • Wer führt das Review durch in erster und zweiter Instanz?
  • Wie wird das Produkt publiziert?
    • In welche Medien, durch wen, in Abstimmung mit wem?
    • Wer wird über die Publikation in Kenntnis gesetzt?
  • Checkliste zur Durchführungsstatistik dieser Punkte
    • Wer hat was und wann erledigt? (Ticketingsysteme wie Jira/Trello o.ä. von Vorteil)

 

Überlegen Sie sich vorab ein System zur Versionierung von Dateien und vermitteln Sie dieses an alle Projektbeteiligten. Wenn Sie kein Redaktionssystem im Einsatz haben, das diese Funktion beinhaltet, gibt es „Low-Budget“-Alternativen wie Github oder Subversion (SVN). Auch OneDrive, Dropbox oder Owncloud lassen sich gut für eine einfache Versionierung nutzen.

Über dieses können Sie Ihre Informationseinheiten stets ausfindig machen und wiederverwenden und erhalten online erstklassige Suchergebnisse. In unserer Rubrik Content Management erfahren Sie mehr.

Versuchen Sie (sprachlich, inhaltlich) den bestmöglichen Bezug von der Dokumentation zu den Oberflächentexten herzustellen. Im besten Fall haben Sie sogar die Möglichkeit, diese zu reviewen und Verbesserungsvorschläge an die Entwicklung zu geben.

Lassen Sie Ihre Informationsprodukte vor der Auslieferung stets überprüfen (auf sprachliche Korrektheit von einem sprachlich versierten Reviewer, auf inhaltliche Korrektheit von einem Mitarbeiter mit Fachwissen, auf technische Korrektheit von einem Entwickler oder Tester). Prüfen und testen Sie abschließend immer nochmal die Hyperlinks und Verweise, Über- und Unterschriften, Umbrüche in gedruckten Dokumentationen etc., um eine außerordentliche Qualität zu liefern.

Stellen Sie sicher, dass für Ihr gesamtes Team eine allgemein gültige Ablagestruktur gilt, diese befolgt wird und die Dateien zentral für alle Beteiligten zugänglich abgelegt werden. Arbeiten Sie NICHT mit lokalen oder per E-Mail verschickten Dateien.

Gehen Sie nicht davon aus, dass alle Teammitglieder das gleiche Verständnis für die Erstellung der nötigen Dokumentation haben, sondern halten Sie alle wesentlichen Informationen und Abstimmungen zu Standardisierung, Struktur der Dokumente, Terminologie der Erfassungssprache, Schreibregeln für die Autoren usw. schriftlich und zentral für alle zugreifbar fest. Kommunizieren Sie diese Regeln klar an alle Beteiligten weiter.

Topic = in sich geschlossene Informationseinheit, die genau eine Frage beantwortet und durch Verlinkungen und verwandte Themen die Relation zu anderen Topics sicherstellt. Erfahren Sie mehr dazu im Bereich Modularisierung auf unserer Seite für Content Management.

Sparen Sie dadurch Zeit und Geld ein. Näheres rund um das Thema Übersetzung in der Technischen Redaktion erfahren Sie in unserer Übersetzungsrubrik.

Abonnieren Sie Newsletter zu den neuesten Trends, besuchen Sie Messen und nehmen Sie an Weiterbildungskursen teil. So finden Sie mögliche Lösungsansätze, um neue Herausforderungen anzugehen.

Erhalten Sie auch in unserem Blog regelmäßige Updates zu den Themen Technische Kommunikation, User-Experience und intelligentes Content-Management.

Warum die Zielgruppenanalyse wichtig ist

Ein etwas überspitztes Zitat einer Aussage, die uns so oder so ähnlich im Arbeitsalltag begegnet:

„Wer die Dokumentation unserer Software benötigt? Naja, das sind Facharbeiter. Manchmal auch neue Mitarbeiter. Die kennen sich schon gut aus mit der Software. Aber benutzt lieber einfache Wörter und viele Bilder, man weiß ja nie, was die wirklich alles wissen…“

Für die Dokumentation der Software muss ermittelt werden, WER die spätere Nutzergruppe ist. Eine Zielgruppenanalyse muss also stattfinden und dient dazu, den Informationsbedarf und den Nutzungskontext der späteren Software-Benutzer zu klären.

Die Nutzergruppen einer Software sind meist sehr heterogen. Je nach Art der Software liegen manchmal Welten zwischen den Kenntnissen, Bedürfnissen und Anforderungen der Benutzer.

Wenn Sie nicht wissen, für WEN Sie Ihre Informationen schreiben, werden Sie nicht wissen, WIE Sie die Informationen schreiben sollen.

Haben Sie Ihre Zielgruppen richtig identifiziert und Ihre Dokumentation wird daraufhin als hilfreich empfunden und gelesen, wird Ihnen nicht zuletzt das Kundensupport-Team danken.

Zielgruppenanalyse
Informationsbedarf

Informationsbedarf der Anwender ermitteln

Welche Informationstiefe und welche Art der Unterstützung ein Benutzer bei der Nutzung einer Software benötigt, hängt unter anderem von seinen Vorkenntnissen im Umgang mit der Software oder ähnlichen Softwareprodukten ab. Daraus ergibt sich für jeden einzelnen Benutzer bzw. für jede einzelne Benutzergruppe ein anderer Informationsbedarf.

  1. Benutzer können im Umgang mit der neuen Software Anfänger, Fortgeschrittene oder Experten sein.
  2. Benutzer können bezüglich der Zielverfolgung mit der neuen Software normale Benutzer, Administratoren oder Programmierer sein.

Die beiden Kategorien lassen sich auch miteinander verknüpfen: Ich kann ein erfahrener PC-Benutzer im Allgemeinen sein und doch vom neu eingeführten Redaktionssystem noch keine Ahnung haben.

Jede Einstufung erfordert folglich unterschiedliche Informationsprodukte für die externe Softwaredokumentation und eine andere Art der Toolunterstützung.

Beispiele für mögliche zielgruppenabhängige Informationsprodukte:

  • Bedienungsassistent
  • FAQ
  • Eingebettete Hilfe
  • Fallbeispiele
  • Quick-Start-Guides
  • Administrator-Guide
  • API-Dokumentation

Nutzungskontext der Software ermitteln

Der Informationsbedarf hängt im Wesentlichen auch mit dem Nutzungskontext zusammen, in dem die Software verwendet wird. Die ISO 9241-11 beschreibt den Nutzungskontext als „die Benutzer, Arbeitsaufgaben, Ausrüstung (Hardware, Software und Materialien) sowie physische und soziale Umgebung, in der das Produkt genutzt wird.“

Das Benutzerverhalten im jeweiligen Nutzungskontext kann, wenn die zu entwickelnde Software den Benutzern noch völlig fremd ist, in einem ersten Schritt nur durch gute Methoden wie das User-Centered-Design ermittelt werden. Durch die Analysen des Nutzungskontextes kann bereits in einer frühen Phase durch interaktive Prototypen die User-Journey erlebbar dargestellt werden.

In vielen Fällen gibt es jedoch bereits einen Software-Vorgänger, mit dem die Benutzer bereits arbeiten und der nun weiterentwickelt oder durch eine fortschrittlichere Software ersetzt werden soll. Hier können, neben der Analyse der neuen Anforderungen, zusätzlich die Erfahrungen des bisherigen Nutzungskontextes herangezogen werden und so kann durch gezieltes Nachjustieren zu einer besseren User-Assistance beigetragen werden.

Die User-Experience-Experten von STYRZ – Technische Redaktion e.K. unterstützen Sie durch jahrelange Berufserfahrung bei der Analyse der User-Journeys und der Umgebungsbedingungen Ihres Produkts.

Nutzungskontext

Fragen, die wir mit Ihnen im Erstgespräch klären

In einem gemeinsamen Erstgespräch versuchen wir Ihre Bedürfnisse, Anforderungen und Ziele zu besprechen und bereits erste Eindrücke über den Nutzer und die Komplexität Ihrer Produkte zu erhalten. Dies ermöglicht uns, Sie besser zu verstehen und eine sehr gute und individuell auf Ihre Anforderungen zugeschnittene Lösung anzubieten.

Welche Art von Produkt soll dokumentiert werden?

Klassische Anwendersoftware, System- oder Embedded Software, Cloud- oder Webbasierte Anwendungen, Mobile Applikationen u.ä.

 

Welche geschäftlichen Ziele möchten Sie mit der Dokumentation Ihres Produkts erreichen?

Vermarktung, Reputationssteigerung, Minimierung der Supportkosten etc.

 

Wer wird die Produkte primär/sekundär einsetzen?

Welche Vorkenntnisse bringen die Anwender mit und in welchem Nutzungskontext wird das Produkt eingesetzt?

 

Wie komplex ist das Produkt?

Wie viele Funktionen/Dialoge/Interaktionspunkte gibt es in der Software und sind bereits konkrete User-Journeys bekannt?

Wie können unsere Redakteure Sie unterstützen?
Nehmen Sie Kontakt auf oder kommen Sie auf einen Kaffee vorbei.