User-Manuals, Online-Hilfen und mehr

Aussagekräftige Produktbeschreibungen mit denen Anwender effektiv arbeiten können, sparen nicht nur Zeit, sie sind zudem ein Aushängeschild Ihres Produkts und ein zusätzliches Verkaufsargument.

In einer guten Software-Dokumentation finden Anwender konkrete Hilfestellung und alles Wichtige für die Arbeit mit der Software. Mit dem Ziel, dem Anwender genau die benötigten Informationen und mit der erforderlichen Relevanz zu liefern, erfordert die Erstellung einer guten Software-Dokumentation Fachwissen, Erfahrung und Zeit.

Der qualitative Anspruch, die Aufgaben des Tagesgeschäfts und Zeitdruck machen diese Aufgabe für die Unternehmen nicht leicht. Es stellt sich somit die Frage, wie hier eine Entlastung für Programmierer und Support erreicht werden kann. Die Lösung heißt: auslagern. Auslagern an bluescript.

Denn wir haben uns auf das Erstellen von Software-Dokumentationen und Online-Hilfen spezialisiert. Wir entlasten Sie als Softwareentwickler, indem wir einen Teil Ihrer verantwortungsvollen Aufgaben für Sie erledigen.

Der Nutzen, der hieraus für Sie entstehen kann, ist vielfältig:

Pünktlich

Das Schreiben der Dokumentationen kann parallel zur Entwicklung erfolgen, sodass geplante Fertigstellungstermine gut eingehalten werden können.

Kompetent

Die Unterlagen werden fachlich kompetent und in einwandfreiem Deutsch verfasst - eine gute Visitenkarte für Sie.

Entlastung

Ihre Mitarbeiter werden von der Erstellung der Dokumentation entlastet, sodass diese mehr Zeit für Ihre Kunden und das Kerngeschäft haben.

Flexibilität

Sie binden Personal und Ressourcen lediglich für den Zeitraum der Dokumentationserstellung. Das spart Kosten für Lohn, Ausfallzeiten, Weiterbildung und für spezielle Software.

Zeitersparnis

Ihre Kunden finden konkrete Hilfestellungen. Eine nicht zu unter-schätzende Zeitersparnis für Ihren Support, da Rückfragen minimiert werden.

Wettbewerbsvorteil

Mit der Dokumentation erhält die Software ein zusätzliches Qualitätsmerkmal. Ein Wettbewerbsvorteil mit dem Sie bei Ihren Auftraggebern punkten können.

Fehlerminimierung

Im 4-Augen-Prinzip werden Benutzeroberfläche und Funktionen nochmals getestet - das hilft Fehler zu vermeiden.

Aktualität

Die Aktualisierung der Dokumentation kann parallel zur Weiterentwicklung der Software erfolgen. Ihren Anwendern liegen somit stets aktuelle Informationen vor.

FAQ - Häufige Fragen zur Software-Dokumentation

Die Software-Dokumentation beschreibt die Funktions- und Arbeitsweise sowie den Aufbau und die Systemvoraussetzungen einer Software. Sie befähigt die Anwender, sicher, effektiv, vollumfänglich und entsprechend ihren Aufgaben mit der Software zu arbeiten.

Die Anwender finden darin Hintergrundinformationen, Handlungsanleitungen und Informationen zur Bedienung der Software und haben damit immer ein Nachschlagewerk zur Hand, welches im Bedarfsfall bei Fragen, Unklarheiten und Fehlern weiterhilft. Die Software-Dokumentation ist somit neben der Anwenderschulung ein wichtiges Hilfsmittel für die tägliche Arbeit mit der Software.

So entstehen zum Beispiel:

  • Software-Hilfen
  • Handbücher zur Software
  • kontextsensitive Hilfe
  • Installationsanleitungen
  • Release Notes
  • Kurzanleitungen
  • Handlungsleitfäden
  • Schulungsunterlagen
  • Technische Datenblätter
  • Websites
  • Kataloge (z. B. Produktkataloge)

Für das Anfertigen einer Dokumentation benötigen wir einen Zugang zur Software und - sofern möglich - vorinstallierte Testdaten bzw. einen Testmandant.

Bei Systemen auf Client-Server-Basis wird die Software auf einem unserer PCs oder Laptops installiert und eingerichtet. Auf diese Weise können wir lokal mit der Software arbeiten. Aber auch der Remote-Zugriff auf einen Ihrer Rechner oder die Bereitstellung eines Arbeitsplatzes bei Ihnen im Haus sind möglich.

Bei Online-Portalen benötigen wir einen Test-Account mit mindestens den zu beschreibenden Programmfunktionen sowie eine Benutzerkennung für das Log-in.

Die Software darf sich durchaus noch in der Entwicklungsphase befinden. Das Schreiben der Dokumentation kann parallel dazu erfolgen. In Absprachen wird dann festgelegt, welche Programmteile wann beschrieben werden.

Wir sind in der Lage, die Benutzerdokumentationen in den unterschiedlichsten Ausgabeformaten erstellen. Das können sowohl Formate für die Druckausgabe als auch für die Bildschirmausgabe sein:

Klassische Formate für die Druckausgabe:

  • Microsoft Word (.doc/.docx)
  • PDF-Dokumente (.pdf)

Formate für die Bildschirmausgabe:

  • Microsoft HTML-Help (.chm)
  • WebHelp (.html)
  • eBook (EPUB)
  • strukturierte Daten (.xml)
  • Videos, Tutorials, Screencasts

Bei Bedarf können wir gern weitere Ausgabeformate publizieren. Sprechen Sie uns an.

Unseren Auftraggebern gegenüber treten wir als externer Dienstleister auf. Je nach Erfordernis übernehmen wir die komplette Dokumentation zu einer Software oder gezielt einzelne Teilaufgaben bzw. Teilprojekte.

Unsere Kunden sind KMU, welche Software für die unterschiedlichsten Branchen entwickeln und vertreiben:

  • Automobilhandel
  • Branchenlösungen
  • Spedition und Logistik
  • Marketing und Vertrieb
  • kaufmännischer Bereich
  • Pflegedienst
  • Weitere Branchen sind natürlich willkommen.

Das klassische Handbuch

Im Ergebnis der Software-Dokumentation entstehen zumeist Handbücher für die Druckausgabe (MS Word/PDF). Diese können als fertige Druckvorlage in die Druckerei gegeben und dem Benutzer anschließend als gedrucktes Handbuch und/oder auch als Daten-CD bzw. zum Download zur Verfügung gestellt werden.

Bei der Gestaltung des Layouts orientieren wir uns stark am Corporate Design des Unternehmens, sodass sich auch das fertige Handbuch optisch nahtlos darin einfügt.

Die HTML-Help

Eine weitere Möglichkeit der Informationsbereitstellung bietet die Microsoft HTML-Help. Sie kann als .chm-Datei direkt in die Software integriert werden, weshalb sie sich besonders für client-server-basierte Anwendungen eignet.

Der Aufruf der Hilfe erfolgt zumeist über die [F1]-Taste oder kontextsensitiv über die Programmfunktionen. Der kontextsensitive Aufruf hat den Vorteil, dass der Benutzer direkt zu den für den aktuellen Programmpunkt relevanten Informationen geführt wird. Obwohl die HTML-Help nach wie vor ihre Anwendung findet, wird sie doch zunehmend von der deutlich flexibleren Online-Hilfe abgelöst.

Die Online-Hilfe

Aktuell setzen sich Online-Hilfen immer mehr durch; meist in Form einer Web-Help, die über den Internet-Browser angezeigt werden kann. Aber auch als App für Smartphones und Tablets oder als E-Book werden Online-Hilfen bereitgestellt.

Die Vorteile einer Online-Hilfe liegen ganz klar auf der Hand:

  • Geräteunabhängigkeit
  • Zeit- und Kosteneinsparung
  • Mobilität und Flexibilität
  • zentrale Datenhaltung
  • ständige Verfügbarkeit
  • geringer Pflegeaufwand
  • Integration von Navigationselementen, Suchfunktionen, multimedialen und interaktiven Elementen

Eine Web-Help wird auf Basis von HTML oder XML erstellt und kann somit auf den unterschiedlichsten Ausgabemedien oder einfach nur im Web-Browser angezeigt werden. Sie ist damit jederzeit erreichbar und ständig verfügbar. Das Layout wird wie bei einer Website über sog. Stylesheets definiert. So ist es leicht, das Aussehen der Web-Help dem Layout der Unternehmenswebsite anzupassen. Die Aufspaltung der Texte in kleine Informationseinheiten (Topics) und die Ergänzung um Meta-Daten ermöglichen zusätzlich ein direktes Ansteuern der Informationen und deren ganz individuelle Zusammenstellung, ähnlich einem Baukasten-System.

Häufig wird die Web-Help zusätzlich zum gedruckten Handbuch erstellt. Moderne Redaktionssysteme, die nach dem System des Single-Source-Publishings arbeiten, machen dies leicht möglich. Sie ermöglichen die parallele Ausgabe des Textes in unterschiedlichen Dateiformaten wie .doc(x), .pdf, .(x)html, xml, epub usw.

Videos, Tutorials und Screencasts

Längst beschränkt sich der Konsum von Videos nicht mehr nur auf die private Nutzung und Unterhaltung. Auch in der Software-Dokumentation haben Videos Einzug gehalten. Durch die Möglichkeit der Verbreitung über soziale Netzwerke und die einfache Integration als multimediales Element in Websites und Web-Help-Anwendungen sind Videos ein beliebtes Instrument zur Vermittlung von Inhalten geworden.

In der Software-Dokumentation kommen Videos gern als Tutorials oder als Screencasts (Bildschirmaufnahmen) zum Einsatz. Mit ihnen können komplexe Vorgänge innerhalb weniger Minuten anschaulich erklärt, Abläufe verdeutlicht und Informationen verständlich vermittelt werden. Sie sind damit eine klare Ergänzung zur klassischen Text-Dokumentation.

Unseren Angeboten liegt eine umfangreiche Kalkulation auf Stundenbasis zugrunde. Dafür erörtern wir zunächst gemeinsam, welche Programmteile beschrieben werden sollen, die Zielgruppe, deren Voraussetzungen, den Umfang und die Ausgabeformate der Dokumentation. Wir erhalten Zugang zur Software und eine kurze Einweisung. Danach arbeiten wir uns in die Software ein und ermitteln den voraussichtlichen Zeitbedarf. Diesen verrechnen wir mit unserem aktuellen Stundensatz und erstellen Ihnen auf dieser Grundlage ein Angebot.

Als Faustregel können Sie für das Schreiben neuer Dokumente mit einem Zeitaufwand von ca 2 Stunden/Seite rechnen, für die Überarbeitung bestehender Texte mit ca. 1 Stunde/Seite.

Projekte (Auszug)

Impressum | Disclaimer | Datenschutz | Sitemap