Handbuch erstellen software


PRICE: FREE

INFORMATION

ISBN: 755981263
FORMAT: PDF EPUB MOBI TXT
DATEIGROSSE: 19,92

ERLAUTERUNG:

Handbuch erstellen software

Anleitungen für Software sollen den Anwender in die Lage versetzen, sich selbstständig einzuarbeiten und bei Bedarf schnell die notwendigen Informationen zu finden. Software-Anleitungen können handlungsorientiert oder funktionsorientiert geschrieben werden. Eine Auszeichnung mit XML ist optional.

Wichtig ist vor allem die Verständlichkeit. Wie kann die Software-Anleitung gegliedert werden? Wie lassen sich Handlungsanweisungen strukturiert schreiben? Sind Schritt-für-Schritt-Anleitungen sinnvoll? Schätze die Zielgruppe ein. Wenn Du einschätzen kannst, wie der Anwender die Anleitung benutzen wird, kannst Du die Informationen gezielt dafür schreiben.

Zum Beispiel:. Noch bevor der Anwender die Software startet oder benutzt, will er wissen, was die Software leistet. Erst wenn er diesen Nutzen versteht, ist er motiviert sich die Software anzusehen. Wahrscheinlich stecken in Deiner Software Features, die Du dem Anwender erst nahe bringen musst.

Auch wenn Du denkst, dass Deine Software selbsterklärend ist, kennt der Anwender diese Funktionen noch nicht. Du kannst alle Funktionen systematisch erklären. Mach die Anleitung rund Titel, Inhaltsverzeichnis …. Wenn Du das getane Werk ansiehst, hast Du möglicherweise schon die benötigte Information für die Software-Anleitung zusammen gestellt und kannst die Kapitel zu einem Buch zusammen stellen.

Wichtige Elemente musst Du noch ergänzen:. Betrachte Dein Werk noch mal, denke an die Zielgruppe und stell Dir vor, wie sie in den Use Cases mit Deiner Anleitung zurecht kommt. Manchmal möchte ich in der Videokonferenz etwas zeigen, ein Buch auf dem Tisch, ein Foto oder etwas in der Werkstatt.

In vielen Unternehmen wird die Technische Dokumentation noch nebenbei von Entwicklern, Produktmanagern oder anderen erledigt. Wenn dann ein Technischer Redakteur eingestellt. Im Maschinenbau schreiben wir Technischen Redakteure Betriebsanleitungen für die Anwender und den Betreiber meistens undifferenziert für beide. Ich frage mich. Startseite Alle Beiträge Kategorien Neues Angebote, Seminare Meinungen Grundlagen TD Step by Step Software Anleitungen Visualisieren Video-Konferenz Links Juhl.

Zehn Schritte zur Software-Anleitung. Prev Previous Etwas mehr Selbstbewusstsein bitte. Next Schritt-für-Schritt — oder geht es auch anders? Smartphone als mobile Webcam oder Dokumentenkamera Manchmal möchte ich in der Videokonferenz etwas zeigen, ein Buch auf dem Tisch, ein Foto oder etwas in der Werkstatt. Doku-Abteilung aufbauen In vielen Unternehmen wird die Technische Dokumentation noch nebenbei von Entwicklern, Produktmanagern oder anderen erledigt.

Betreiber als Zielgruppe? Kategorien Neues 15 Angebote, Seminare 4 Meinungen 8 Grundlagen TD 14 Step by Step 5 Software Anleitungen 8 Visualisieren 5 Video-Konferenz 3 Links 4. Erstellung Bücher Schulung Beratung. Technische Dokumentation Freiberufler Senior Consultant Impressum. Online-Meeting Zoom-Konferenz Downloads.

Weekly Newsletter.

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.