Softwaredoku ist bei dir ein Frustthema?

Du brauchst eine moderne, integrierte, nutzungsfreundliche Softwaredokumentation!

Modern

Die Zeit der textlastigen, seitenlangen, gedruckten Handbücher haben wir hinter uns gelassen. Doch oft ist die Softwaredoku eben trotzdem noch ein Handbuch, nur eben digital. Moderne Softwaredokumentation ist da, wo das Problem ist: bei den User:innen in genau der Problemsituation.

Integriert

Die Softwaredokumentation ist Teil des Entwicklungsprozesses der Software. Damit die Dokumentation mehr Lust statt Frust macht, muss sie effektiv und einfach erstellt werden. Dazu brauchst du die richtigen Tools. So läuft die Doku fast nebenbei!

Nutzungsfreundlich

Deine Doku soll Spaß machen! Moderne Softwaredokumentation bietet interaktive Elemente wie Videos, Tutorials und Code-Beispiele, um deinen User:innen ein praxisnahes Erlebnis zu bieten. Mit durchdachter UX sorgst du für Motivation und Zufriedenheit – und zufriedene Kund:innen, sind treue Kund:innen.

Moderne Softwaredokumentation bedient sich aus dem Mix von smarten Workflows, ausgewählten Tools und neuen Lernmedien. Spielen diese drei perfekt zusammen, schaffst du eine zeit- und kosteneffiziente Dokulandschaft. Werden wir also konkret:

Du weißt also, was du willst; super!

Die Umstrukturierung deiner Prozesse und Tools wird deine Softwareanleitung besser machen und nebenbei auch noch das eventuell vorhandene Chaos in deiner Abteilung aufräumen.

Das ist die Hauptfrage unserer bisherigen Kund:innen gewesen. Und da gibt es von uns ein ganz klares JA! Initialkosten von Tool und Prozessgestaltung sind da, das müssen wir nicht wegreden. Doch eine unrund laufende Abteilung, viele Anfragen an den Support und manuelle statt automatischer Prozesse sind auf Dauer viel teurer. Gerne sprechen wir mit dir über deinen Return-On-Invest (ROI).

Doch wie kannst du diese Vorteile mit möglichst wenig Aufwand bekommen?

Unsere Kund:innen erzählten uns immer wieder von dem Mangel an Know-How und Zeit, um solch ein Projekt intern stemmen zu können.

Die Lösung? Ganz einfach! Du braucht jemanden, der die aufwendigen Arbeiten abnimmt und dich „ready to go“ macht. Du und dein Team könnt euer anspruchsvolles Alltagsgeschäfts weiterführen und wir bereiten alles vor für euch.

Da kommt STYRZ ins Spiel

Wir starten, wo du stehst.

Zunächst brauchst du eine Vision: Wie soll deine Softwaredokumentationslandschaft aussehen?

Mit dieser Frage bist du bei uns genau richtig. Denn die Frage nach dem „wie“ haben wir bereits für viele Kund:innen erfolgreich beantwortet.

In einem Workshop identifizieren wir deine Vision, leiten klare Handlungsempfehlungen ab, definieren einen Fahrplan und begleiten dich als Partner gerne bei der Konzeption, der Umsetzung bis hin zur Pflege deiner Informationsprodukte.

Im Workshop erstellen wir also mit dir die Anleitung für eine modernen und zeitgemäßen User-Assistance für deine digitalen Produkte und helfen dir bei Bedarf dabei, das identifizierte Hilfe-Konzept umzusetzen.

 

Möchtest du deine Softwaredokumentation professionell aufbauen? Dann findest du auf den weiteren Seiten unter „Softwaredokumentation“ alle Infos darüber, wie so ein Aufbau mit STYRZ abläuft.

Du möchtest deine Softwaredokumentation mit neuen Technologien noch besser machen? Dazu gibt es verschiedene Bausteine.

Eine kontextsensitive Online-Hilfe ist eine HTML-Anleitung, die direkt aus deinem Softwareprodukt heraus aufgerufen werden kann. Die Online-Hilfe greift beim Aufruf den Kontext deiner Anwenderinnen und Anwender auf.

In der Online-Hilfe können neben anleitenden Informationen auch Grundlagenwissen (Konzepte), Referenzinformationen (Daten und Parameter), Problemlösungen oder häufig gestellte Fragen enthalten sein. Im Zusammenspiel bieten diese Informationen deinen Nutzerinnen und Nutzern eine moderne, ganzheitliche Softwaredokumentation.

Wir helfen dir bei der Konzeption, Planung und Erstellung der kontextsensitiven Online-Hilfe für deine Produkte.

Eine kontextsensitive Online-Hilfe gehört zu den „klassischen“ Ansätzen in der Softwaredokumentation und stellt nur einen Teil einer ganzheitlichen Software-User-Assistance dar.

Bei interaktiven Anleitungen bzw. interaktiven Software-Touren oder auch automatisierte Software-Demos genannt, handelt es sich um digitale Starthilfen im Produkt selbst.

Meist für neue Anwenderinnen und Anwender umgesetzt, wird diesen nach dem ersten Log-in im System eine „Tour“ durch dein Softwareprodukt angeboten.

Eine interaktive Softwaredokumentation nimmt deine Anwenderinnen und Anwender an die Hand und leitet diese an einem praktischen Beispiel durch ein Tutorial im Produkt. Dieses Tutorial dient dazu, wichtige Funktionen aufzugreifen und deine Anwenderinnen und Anwender an den entsprechenden Stellen zur Interaktion aufzufordern.

Durch diesen praktischen Durchlauf im Produkt selbst, festigt sich das Wissen bei deinen Anwenderinnen und Anwendern und hat den Vorteil, dass die Einstiegshürde in dein Produkt sinkt.

Wir beleuchten gerne die richtigen Tools für deine interaktiven Anleitungen, erstellen die Konzepte, analysieren die Geschäftsprozesse und unterstützen dich bei der Integration der Informationen zu den Touren in deinem Produkt.

Web Based Training (WBT) oder webbasiertes Lernen (WbL) in der Softwaredokumentation beschreiben Lernprogramme, die deinen Anwenderinnen und Anwendern mittels digitalen (Video-)Lernkursen den Umgang mit deinem Softwareprodukt beibringen.

E-Learning-Formate werden immer beliebter und bieten deinen Anwenderinnen und Anwendern zeitliche, räumliche und inhaltliche Flexibilisierung der Lernprozesse und Aufwände.

So werden zum Beispiel Grundlagen-, Power-User- oder Administrator-Trainings in mehrere kleine Video-Lerneinheiten aufgeteilt und ermöglichen deinen Anwendenden einen verteilten und bedarfsoptimierten „Verzehr“ der Learning-Nuggets.

Auch für dich hat ein Videokurs erhebliche Vorteile, denn Schulungs- und Personalaufwände werden optimiert und deine Trainer:innen können gezielt für Trainings mit komplexen Anforderungen bei deinen Kunden eingesetzt werden. „Standard-Trainings“ müssen hingegen nach der Aufnahme als E-Learning lediglich gepflegt werden.

 

Microcopy bezeichnet die kleinen,  in die Benutzeroberfläche (GUI) integrierten Texte. GUI-Texte beschreiben ein Element deiner GUI oder dienen dazu, deine Anwenderinnen und Anwender zu informieren, anzuleiten oder zu motivieren.

Ein gutes UX-Writing erleichtert die Bedienung deines Produktes und steigert erheblich die User-Experience in deinem Softwareprodukt. Zudem spart gute Microcopy deinen Anwenderinnen und Anwendern den Blick in die Online-Hilfe für kleine, aber vorhandene Hürden.

Wir unterstützen dich gerne bei der Entwicklung von UX-Writing-Prozessen, der Definition einer UX-Writer-Rolle in deinem Unternehmen oder der Erstellung von Texten für deine Benutzeroberfläche.

Videoanleitungen sind bekannt aus gängigen Online-Video-Portalen als How-To-Anleitung oder Tutorial zu bestimmten Aufgaben. How-To-Videos oder Screencasts sind eine gute Ergänzung zu deiner Softwaredokumentation. Video-Tutorials werden oftmals von versierten Nutzern erstellt, die ihre Erfahrungen, Tipps und Tricks im Umgang mit Ihrem Produkt mit der eigenen Community teilen.

Videos sind in einer modernen Softwaredokumentation bzw. einer ganzheitlichen User-Assistance nicht mehr wegzudenken. Als Screencast in die Online-Hilfe integriert, können diese zum Beispiel als Endlosschleife in einer Anleitung verwendet werden. Eine platzsparende und deutlich verständlichere Alternative zu Screenshots (Bildern).

Screencasts bieten Vorteile, die die User-Experience bereits vor dem Produkterwerb positiv beeinflussen können und gleichzeitig einen hohen Mehrwert in der Softwaredokumentation für deine Anwenderinnen und Anwender bieten.

Wir erstellen für dich Screencast-Konzepte und Skripte, die deinem CI entsprechen. Wir nehmen die Screencasts gerne für dich auf und übernehmen die Videobearbeitung. Professionell, schnell und effizient.

Mit einem Help-Center oder User-Communitys zu deinen Produkten ermöglichst du deinen Anwenderinnen und Anwendern ein umfassendes Self-Service-Erlebnis. Ein Hilfe-Portal bietet den schnellen Zugang zu Hilfe-Artikeln für häufig aufkommende Fehlerszenarien.

Im Falle einer Community helfen oftmals versierte Anwender und Anwenderinnen mit deinen Erfahrungen, Tipps und Tricks im Umgang mit deinem Produkt.

Das hat für dich als Hersteller den Vorteil, dass du dich auf die Sicherung der Qualität der generierten Inhalte in der Community konzentrieren kannst.

Deine Anwenderinnen und Anwender erstellen dadurch mit der Zeit eine Wissensdatenbank für Self-Service-Inhalte, von denen nicht nur die Anwendenden selbst, sondern auch du als Hersteller im Kundenservice und der Produktentwicklung massiv profitieren kannst.

Ein durch dich moderierter Kanal für deinen User-Generated-Content ist wichtig und sollte in keinem Fall einem Wildwuchs überlassen werden. Denn eins ist klar… der Content entsteht – mit oder ohne deinem Zutun. Sei daher proaktiv und nutze diesen Kanal für herausragenden Service und bestes Marketing.

 

Dabei können wir dich unterstützen:

Mit unserer Expertise unterstützen wir dich beim gesamten Prozess der Softwaredokumentation, komplett aus einer Hand oder als zuverlässiger Partner neben deinem internen Redaktionsteam. Du entscheidest, wie viel und wofür du uns brauchst.

  • 1.

    Dir fehlen die Ressourcen für die Technische Dokumentation und du kannst mit der Entwicklungsabteilung nicht Schritt halten?

  • 2.

    Du weißt nicht, was moderne Softwaredokumentation auszeichnet und wie diese technisch zuverlässig implementiert werden kann?

  • 3.

    Mitarbeiter schreiben die Dokumentation „nebenbei“, doch durch den auslastungsbedingten Zeitmangel hinkt die Softwaredokumentation hinterher?

  • 4.

    Der Prozess der Dokumentationserstellung ist nicht durchdacht und daher ineffizient, mühsam und viel zu starr für die agile Softwareentwicklung?

Lerne uns bei einem Erstgespräch kennen! Gemeinsam betrachten wir deinen IST-Zustand und zeigen dir Optimierungspotentiale auf. Lass uns gemeinsam deine Vision von einer einfachen, modernen Softwaredokumentation wahr machen!

Noch nicht 100% überzeugt?

Schau doch mal auf unserem Blog vorbei!

Dort schreiben wir über Aktuelles aus dem Bereich Technische Kommunikation, über unser Know-How und wertvolle Tipps für deinen Arbeitsalltag.

Erfahre so noch mehr darüber, wie wir deine Softwaredokumentation unterstützen können.

Technische Dokumentation

Konformitätserklärung: Was ist das? Inhalte und Beispiele

18.04.2024

Technische Dokumentation

Digitalisierung im Maschinenbau - Dokumentation endlich einfach!

04.04.2024

UX und UX-Writing

UX-Research: Was ist das und was bringt es der Technischen Redaktion?

21.03.2024