Handbucher erstellen software


PRICE: FREE

INFORMATION

ISBN: 372136298
FORMAT: PDF EPUB MOBI TXT
DATEIGROSSE: 12,90

ERLAUTERUNG:

Handbucher erstellen software

Leider haben nur wenige Projekte ein Augenmerk auf die Dokumentation, die sie bereitstellen. Sondern betrachten diese Aufgabe als lästiges Übel. Bei den Anwendungen, welche die Geschäftsprozesse unterstützen, werden meist nur Teile der erworbenen oder gemieteten Software genutzt. Welche Prozesse, wann und in welcher Art und Weise abgebildet werden, ist von Unternehmen zu Unternehmen, von Bereich zu Bereich unterschiedlich. Was anfänglich noch logisch und strukturiert abgebildet wird, verliert mit zunehmender Komplexität und Anzahl an Prozess-Varianten an Logik.

Da muss plötzlich hier eine Option aktiviert werden, die gar nicht zum Prozess passt; da tauchen inhaltlich gleiche Felder mit unterschiedlicher Benennung auf oder Feldnamen werden so benannt, dass der Anwender zweimal um die Ecke denken muss. Da dies bei so ziemlich jeder Software-Einführung passiert, braucht es eine Lösung, die dem Anwender im Alltag hilft, sich zurecht zu finden.

Wir sollten uns nicht alleine auf dessen Intuition verlassen, denn die würde viel zu oft die falsche Antwort liefern. Deshalb braucht es prozess-orientierte Bedienungsanleitungen, die Schritt für Schritt beschreiben, was zu tun ist. Hier finden Sie sechs Tipps, die Sie beim Erstellen von anwendergerechter Dokumentation beherzigen sollten:. Sprechen Sie die Sprache der Anwender Raster, Grids, Multi-Value usw. Der Anwender denkt und spricht von Fenstern, Feldern, Zeilen und Auswahllisten.

Sollten Sie diese IT-lastigen Begriffe dennoch verwenden wollen, sollten Sie gute und nachvollziehbare Gründe für diese Entscheidung haben. Dann sollten Sie diese Begriffe konsistent und konsequent benutzen. Ohne Ausnahme. Wir schreiben für unsere Anwender, nicht für uns selbst. Also müssen wir deren Sprache nutzen. Um die richtigen Begriffe finden zu wollen, hören Sie den Anwendern zu.

Welche Anwendungen werden sonst noch benutzt und welche Begriffe werden dort bereits verwendet? Sie müssen das Rad nicht von vorne erfinden sondern, nutzen, wenn immer möglich schon etwas Vorhandenes. Stellen Sie ihrer Dokumentation ein Kapitel zur Begriffsklärung voran, um diese zu erläutern. Schaffen Sie Vertrauen Stellen Sie sich vor, Sie haben sich einen neuen Fernseher gekauft.

Ein tolles Gerät mit vielen Funktionen, auf die Sie ganz neugierig sind. Dem Gerät liegt eine mehrsprachige Bedienungsanleitung anbei. Sie finden die von Ihnen bevorzugte Sprache und folgen der Bedienungsanleitung gewissenhaft.

Leider, ohne ans gewünschte Ziel zu kommen. Das Gerät funktioniert nicht so, wie es beschrieben ist. Sie vergeuden wertvolle Zeit, werden wütend, verlieren die Lust und fragen sich, ob das Gerät genauso schlecht ist, wie die Bedienungsanleitung dazu. Haben Sie jedoch eine Anleitung, die jeden Schritt nachvollziehbar beschreibt und die Anwendung funktioniert in der angegebenen Art und Weise, dann schafft das Vertrauen und erspart Ihnen Ärger, Fragen und fehlerhafte Daten. Geben Sie sich ruhig ein bisschen Mühe, die Dokumentation ansprechend zu gestalten.

Das erhöht die Chance, dass die Anwender diese tatsächlich in die Hand nehmen. Dann ist die Dokumentation ein Verkaufsprospekt für Ihre Lösung. Nutzen Sie die Dokumentation während des Trainings Das Erstellen einer guten Anwender-Dokumentation bedeutet Aufwand.

Nutzen Sie diese Dokumentation deshalb so oft es geht. Zusätzliche Schulungsunterlagen, die nur in den Trainings verwendet werden, ergeben keinen Sinn. Lassen Sie die Anwender bereits in den Trainings die Dokumentation nutzen. Verweisen Sie immer wieder darauf. Eine logische Reihenfolge der Inhalte kann die Reihenfolge sein, in der die Inhalte vermittelt werden.

Nutzen Sie die Dokumentation, damit sich die Teilnehmer während der Trainings Inhalte selbst erarbeiten. Das schafft Vertrauen in die Dokumentation aber auch in das Ego des Teilnehmers: "Ist doch gar nicht so schwer. Steht ja alles hier drin.

Präzision, Wahrheit und Klarheit Manchmal ist es nicht so optimal, wie die Software im Alltag reagiert oder womit sie gefüttert werden will. Manche Arbeitsschritte oder Funktionen sind, gerade anfänglich, vielleicht sehr langsam. Geben Sie den Anwendern dazu klare und präzise Anleitungen. Sie sollen ganz genau wissen, welche Option sie wann auswählen müssen.

Sie wollen nicht interpretieren. Könnte, sollte, würde, eventuell, wahrscheinlich - können Sie aus dem Wortschatz streichen. Präzision ist gefragt, Struktur und die ganze Wahrheit, auch wenn sie sich nicht schön anhört. Wir schreiben nicht den Roman Vom Winde verweht sondern eine Bedienungsanleitung, die keinen Spielraum für Interpretation lässt.

Und, wenn es tatsächlich so ist, dann schreiben wir auch fünf Mal hintereinander: Klicken Sie. Fasse Dich kurz Jedes Wort, das wir schreiben, muss vom Anwender gelesen werden. Es verlängert auch das Korrekturlesen und das Überarbeiten. Prüfen Sie jede Silbe und Wort darauf, ob es notwendig ist und eine zusätzliche Information enthält. Wenn nicht: weg damit. Schreiben Sie kurze Sätze.

Denken Sie daran, dass auch für den Anwender der Nutzen überwiegen muss. Mach den Dummy-Test Machen Sie den Dummy-Test: Eine Dokumentation ist gut, wenn ein beliebiger Anwender ohne Vorkenntnisse und Training, anhand der dokumentierten Anleitung die Software bedienen und die Prozesse umsetzen kann. Wenn Ihre Dokumentation das schafft, dann ist sie wirklich gut. Mit einer solchen Dokumentation lässt sich die Trainingsdauer verkürzen, es gibt weniger Anfragen beim Support und auch die Prozess- und Datenqualität wird sie positiv überraschen.

Übrigens, wenn wir von Dokumentation sprechen, dann kann diese auch Online, zumBeispiel wiki-basiert, in Ihrem Intranet bereitgestellt werden. Nutzen Sie das Format, das ihre Anwender bevorzugen. Lesen Sie auch : Microsoft - Alles, was Sie zur neuen Abo-Suite wissen sollten.

Zur Startseite.

Zu den Hauptaufgaben bei der Erstellung von Handbüchern gehört es, Verständlichkeit und Nachvollziehbarkeit sowie die Erfüllung gesetzlicher und normativer Anforderungen richtlinienkonform sicherzustellen:. Die DIN EN gibt allgemeine Grundsätze zur Erstellung von Gebrauchsanleitungen vor.

Diese Norm ist eine hilfreiche Unterstützung für das Schreiben eines Handbuchs. Damit sind Sie auf der sicheren Seite. Wir haben für Sie die wichtigsten Infos zusammengestellt. Die Norm gibt eine Anleitung an die Hand, die die wesentlichen inhaltlichen Aspekte des Handbuchschreibens enthält, sowie einen Anhang mit einer Prozessbeschreibung für die Planung und Erstellung.

Sie ist also sowohl eine inhaltliche Richtschnur als auch ein Vorgehensmodell für die Erstellung. Folgende Abschnitte sind für das Schreiben vom Handbuch besonders interessant. Wer erstellt Ihre Handbücher? Sie haben Fragen zur Dokumentationserstellung?

Beratung in Sachen Dokumentation. Die Technische Dokumentation im Maschinen- und Anlagenbau beschreibt den gesamten Lebenszyklus des Produkts. Die Handbücher sind fester Bestandteil der Maschine, sie enthalten alle erforderlichen Informationen und Anleitungen zur sicheren Benutzung. Deshalb sind sie auch in die Amtssprache des jeweiligen Landes übersetzt, in das die Maschine geliefert wird. Die Betriebsanleitungen, die für die Sicherheit und den Gesundheitsschutz der Benutzer relevant sind, sollen als gedrucktes Handbuch vorliegen.

Der Grund dafür ist, dass nicht jeder Benutzer immer die Möglichkeit hat, die Betriebsanleitung in elektronischer Form zu lesen. Es ist aber auch üblich, ein gedrucktes Handbuch mit auszuliefern und die Dokumentation zusätzlich online zur Verfügung zu stellen.

Online angebotene Handbücher werden in letzter Zeit gerne in Content Delivery Portalen zur Verfügung gestellt. Auf diese Weise können Hersteller sicherstellen, dass Ihren Kunden immer Zugriff auf die aktuellste Dokumentation haben. Content Delivery Portale. Eine sehr wichtige Motivation für ein gut geschriebenes und verständliches Handbuch ist es, die Sicherheit der Benutzer zu gewährleisten. Dabei ist in vielen Richtlinien zu lesen, dass die Textverständlichkeit und Zielgruppenorientierung einen immer höheren Stellenwert bekommen: Die Betriebsanleitung soll dem allgemeinen Wissenstand und der Verständnisfähigkeit der Benutzer Rechnung tragen.

Auch Softwaredokumentation, die zunächst als Online-Hilfe erstellt wird, kann als Handbuch publiziert werden. Das Handbuch für eine Softwareanwendung wird in der Regel mit dem Softwareprodukt als Online-Hilfe ausgeliefert. Dennoch machen moderne Redaktionssysteme es möglich, verschiedene Ausgabeformate crossmedial zu publizieren. So ist es möglich, die Softwaredokumentation nicht nur als Online-Hilfe, sondern auch als Handbuch zu publizieren.

Neben den Unterschieden zwischen der Online-Hilfe für Softwaredokumentation und Handbüchern gibt es freilich auch eine Reihe von Überschneidungen mit der Textsorte Handbuch. Im Bereich der Softwaredokumentation haben Online-Hilfen aus einer Reihe von guten Gründen die Nachfolge von Handbüchern angetreten, dabei allerdings auch einige Strukturmerkmale von ihnen übernommen: Ordnungsstrukturen wie etwa ein hierarchisch gegliedertes Inhaltsverzeichnis mit Haupt- und Unterkapiteln oder ein Schlagwortregister wird man sowohl in Handbüchern als auch in Online-Hilfen antreffen.

Home Technische Dokumentation Beratung Softwaredokumentation Handbuch Redaktionsleitfaden Link-Konzept Textarme Handlungsanleitungen Lektorat Übersetzung Kompetenzen Intelligenter Content Redaktionssystem Reifegrad Content-Delivery-Portal Standards Metadaten Warnhinweise Cross Media Publishing Single-Source-Publishing-Verfahren Screenshots Textverständlichkeit Produktdokumentation Trends Scrum - Agile Dokumentation Assistenzsystem Outsourcing Referenzen Über uns Karriere Qualität Presse - Info Partner.

Handbuch richtlinienkonform schreiben - mit den Inhalten auf der sicheren Seite sein Zu den Hauptaufgaben bei der Erstellung von Handbüchern gehört es, Verständlichkeit und Nachvollziehbarkeit sowie die Erfüllung gesetzlicher und normativer Anforderungen richtlinienkonform sicherzustellen: Hochwertige Neuerstellung Ihrer Handbücher. Wir schreiben beispielsweise Installationsanleitungen, Gebrauchsanleitungen, Bedienungsanleitungen. Akkurate Pflege und systematische Optimierung der Handbücher.

Erstellung übersetzungsoptimierter Texte durch einen hohen Grad an Konsistenz und Standardisierung. Organisatorische Aufgaben im Zusammenhang mit dem Übersetzungsdienstleister und Qualitätssicherung der übersetzten Handbücher.

DIN EN Handbuch schreiben leichtgemacht. Beratung in Sachen Dokumentation Die wesentlichen Punkte der Norm für Ihr Handbuch in kompakter Form: Prinzipien Das Niveau sowie die Informationstiefe des Handbuchs sollen zielgruppengerecht aufbereitet sein. Dabei steht auch die Sprache im Vordergrund: Zielgruppenorientierung wird durch verständlich geschriebene Handbuchtexte sowie konsistente Terminologie erreicht.

Eine Hauptaufgabe eines Handbuchs besteht in der Warnung vor den Gefahren, die von einem Produkt ausgehen. Dies soll durch Sicherheitshinweise gewährleistet werden. Die Dokumentation muss mediengerecht sein, beispielsweise sollte eine Installationsanleitung für eine Software als gedrucktes Handbuch vorliegen und nicht in der Online-Hilfe, die erst nach der Installation zur Verfügung steht. Inhalt von Gebrauchsanleitungen Die Norm enthält 15 Abschnitte darüber, was ein Handbuch enthalten sollte.

Wie muss das Produkt transportiert, in Betrieb genommen, instand gehalten und entsorgt werden? Welche Informationen über mitgelieferte Zubehörteile, spezielle Werkzeuge oder zur Reparatur gehören in Ihr Handbuch? Darüber hinaus geht es auch um die Struktur der Gebrauchsanleitung: Wenn Sie mehr als ein Handbuch benötigen, um Ihr Produkt zu beschreiben, dann müssen die verschiedenen Handbücher eindeutig zu erkennen sein.

Gestaltung von Gebrauchsanleitungen Die Norm widmet der Textverständlichkeit einen eigenen Abschnitt. Neben den allgemeinen Regeln, die auch für das Schreiben eines Handbuchs gelten, sollten Informationsklassen für die Handbücher entwickelt werden, die den Textfunktionen entsprechen.

Die Struktur des Handbuchs sowie Schreibstil und Formulierung bedingen sich und sollten in einem Redaktionsleitfaden festgehalten werden. Ist Ihr Handbuch normenkonform erstellt oder müssen Sie es umschreiben? Die Norm enthält auch eine Prozessbeschreibung des redaktionellen Ablaufs für die Erstellung von Handbüchern. Handbuch übersetzen Die Handbücher sind fester Bestandteil der Maschine, sie enthalten alle erforderlichen Informationen und Anleitungen zur sicheren Benutzung.

Übersetzung Ausgabeformate: gedruckt oder online Die Betriebsanleitungen, die für die Sicherheit und den Gesundheitsschutz der Benutzer relevant sind, sollen als gedrucktes Handbuch vorliegen. Content Delivery Portale Textverständlichkeit und Zielgruppenorientierung Eine sehr wichtige Motivation für ein gut geschriebenes und verständliches Handbuch ist es, die Sicherheit der Benutzer zu gewährleisten.

Hersteller müssen folgende Handbuch-Typen erstellen und mit ausliefern: Montageanleitung Installationsanleitung Betriebsanleitung Instandhaltungsanleitung Online-Hilfe für Software schreiben und als Handbuch publizieren Auch Softwaredokumentation, die zunächst als Online-Hilfe erstellt wird, kann als Handbuch publiziert werden.