Software handbuch aufbau


PRICE: FREE

INFORMATION

ISBN: 607260463
FORMAT: PDF EPUB MOBI TXT
DATEIGROSSE: 12,94

ERLAUTERUNG:

Software handbuch aufbau

INSTRKTIV berät und unterstützt beim Schreiben ihrer Software Anleitung, etwa Hilfedateien, Video-Anleitungen, WebHelp, Online Hilfe und App-Gebrauchsanweisungen. Sie Möchten eine Software Anleitung erstellen? Zweck einer Software-Anleitung ist es, dem Nutzer eines Softwareprodukts Informationen darüber zu vermitteln.

Unter Software verstehen wir sowohl Softwarepakete als auch Software auf Geräten wie Smartphones, intelligenten Thermostaten und Meta-Produkten. Eine Software-Anleitung hat zum Zweck, dem Nutzer Anweisungen zu erläutern und bei eventuellen Fehlern Unterstützung bei deren Behebung zu leisten.

Umfassende Kenntnis der Unterschiede trägt zu Qualität der Anleitung bei. Nachstehende Aufzählung benennt kurz die wichtigsten Eigenschaften einer Software-Anleitung. Daher ist es wichtig, nur das absolute Minimum der erforderlichen Informationen anzugeben. Sämtliche nicht relevanten Informationen, die unter zusätzliches Wissenswertes fallen, werden nicht in die Anleitung aufgenommen, um die Aufmerksamkeit auf das Erlernen der entsprechenden Fähigkeit zu richten.

Nutzer möchten etwas mit ihrem Produkt gestalten und nicht darüber lesen. Minimalismus Prinzip Nr. Setzen Sie die Einladung, die Software zu entdecken, ans Ende eines Kapitels oder eines Abschnitts. Das optimale Gleichgewicht zwischen der Erteilung einer Anweisung und der Förderung der Neugierde variiert je Projekt stark. Sorgen Sie jedoch immer dafür, dass die Neugierde des Nutzers eine angemessene Wahrscheinlichkeit auf Erfolg hat und relativ sicher ist.

Der Nutzer muss leicht wieder zum Ausgangspunkt zurückkehren können. Vermitteln Sie grundlegende Informationen dann, wenn der Nutzer dafür am besten empfänglich ist. Nutzer von Software sind mehr daran interessiert, grundlegende Informationen zu erfahren, nachdem sie Funktionen ausprobiert haben.

Nutzer möchten häufig ein kurzfristiges Ziel erreichen und weniger raffiniert als der Ersteller der Software Anleitung. Ein Beispiel ist die passive Hilfefunktion, die vom Nutzer dann eingeschaltet werden kann, wenn er denkt, diese zu benötigen. Gestalten Sie Anweisungen wie tatsächliche Aufgaben. Der Aufbau der Anleitung muss die Struktur der Aufgabe widerspiegeln Minimalismus Prinzip Nr. Der Nutzer muss beim Lesen einer Überschrift wissen, warum er Zeit in das Lesen dieses Abschnitts investieren soll.

Arbeiten Sie themenbasiert. Jedes Kapitel und jeder Abschnitt muss eine Antwort auf lediglich eine Frage bieten. Versuchen Sie in Überschriften, auch immer auf das Thema zu verweisen. Siehe nachstehendes Beispiel. Die beste Möglichkeit zur Fehlervermeidung ist es, selbst die Software gründlich zu prüfen.

Zudem kann erwogen werden, einen Trainingsmodus einzurichten, in dem bestimmte Funktionen während der Trainingsphase nicht verwendet werden können. In der Anleitung können die Grundregeln oder Richtlinien für das Schreiben guter Texte angewendet werden, beispielsweise:. Der Ersteller der Software-Anleitung muss sich die Zeit nehmen, die Software-Anleitung mit Nutzern zu testen.

Verwenden Sie eine schrittweise Gliederung, um Probleme oder Fehler zu beheben. Schritte dieser Gliederung:. Fehlererkennung und Fehlerbehebung sind immer erforderlich. Fehlerermittlung ist nicht immer erforderlich, um den Fehler auch tatsächlich zu beheben. Informationen über Fehler sind häufig wertvolle grundlegende Informationen.

Nutzer verwenden eine Software-Anleitung nicht systematisch. Meist lesen Sie die Anleitung, um etwas zu tun, aber gelegentlich auch, um Wissen zu vertiefen oder gezielt Informationen zu suchen. Durch die kurze und prägnante Formulierung und nicht sämtliche vorhandenen Informationen darzustellen, werden alle Lesestrategien unterstützt.

Kurze Sätze, Aufgaben, Themen, Kapitel usw. Da nicht sämtliche Informationen dargestellt werden, wird der Nutzer angeregt, selbst zu recherchieren und selbst nachzudenken. Lassen Sie zudem sämtliche Informationen weg, die den Nutzer ablenken könnten. Tipp von INSTRKTIV: Geben Sie an, wie lange es dauert, eine Aufgabe zu erledigen. Eine Faustregel besagt, dass eine Aufgabe nicht länger als 20 Minuten dauern sollte. Ein in sich geschlossenes Kapitel bzw.

Vollständige Modalität ist jedoch nicht immer möglich. Achten Sie auf die Darstellung. Vermeiden Sie, dass eine Software Anleitung den Umfang eines Telefonbuches hat. Lassen Sie ausreichend Freiraum am Rand, zwischen den Zeilen und um Abbildungen. Dies verbessert die Lesbarkeit und Verständlichkeit eines Textes. Denken Sie über die Schriftart nach. Wählen Sie für die Veröffentlichung online eher eine serifenlose Schriftart und für die Veröffentlichung auf Papier eine Schriftart mit Serifen.

Sorgen Sie dafür, dass das Inhaltsverzeichnis und die Produktoberfläche eine komplementäre Informationsarchitektur besitzen. Die Anleitung strukturiert Informationen thematisch, während die Oberfläche diese visuell darstellt.

Wenn die thematische Struktur nicht der visuellen Struktur entspricht, kann dies den Nutzer verwirren. Häufig wird entschieden, einfachere Sätze zu formulieren und Fachsprache sowie Fachbegriffe zu vermeiden. Meist enthält die Oberfläche jedoch bereits Terminologie. Zur Sicherstellung der Konsistenz wird die verwendete Terminologie am besten in einem Glossar in der Software Anleitung erläutert.

Beachten Sie die Reihenfolge der Aktionen. Ein Nutzer möchte in der Reihenfolge vorgehen wie in der Anleitung beschrieben. Erwägen Sie den Einsatz von Bausteinen für unterschiedliche Informationsformate je Thema. ERFAHREN SIE MEHR ÜBER UNSER ANGEBOT. Kontakt aufnehmen? Füllen Sie das Formular aus und wir nehmen Kontakt mit Ihnen auf. NEHMEN SIE KONTAKT MIT UNS AUF. Eine Software-Anleitung erstellen? FORDERN SIE DIREKT EIN ANGEBOT AN. Grundlegendes vermitteln Vermitteln Sie grundlegende Informationen dann, wenn der Nutzer dafür am besten empfänglich ist.

Integrität des Nutzers wahren Nutzer möchten häufig ein kurzfristiges Ziel erreichen und weniger raffiniert als der Ersteller der Software Anleitung. Auf Aufgaben abzielen Gestalten Sie Anweisungen wie tatsächliche Aufgaben. Überschriften besondere Aufmerksamkeit widmen Der Aufbau der Anleitung muss die Struktur der Aufgabe widerspiegeln Minimalismus Prinzip Nr. Nutzertests durchführen Der Ersteller der Software-Anleitung muss sich die Zeit nehmen, die Software-Anleitung mit Nutzern zu testen.

Fehler beheben Verwenden Sie eine schrittweise Gliederung, um Probleme oder Fehler zu beheben. Schritte dieser Gliederung: Fehlererkennung Fehlerermittlung Fehlerbehebung Fehlererkennung und Fehlerbehebung sind immer erforderlich.

Kurz und prägnant formulieren Nutzer verwenden eine Software-Anleitung nicht systematisch. Entsprechende Darstellungsform wählen Achten Sie auf die Darstellung. Konsistente Informationen schaffen Sorgen Sie dafür, dass das Inhaltsverzeichnis und die Produktoberfläche eine komplementäre Informationsarchitektur besitzen. Reihenfolge der Aktionen beachten Beachten Sie die Reihenfolge der Aktionen. Bausteine verwenden Erwägen Sie den Einsatz von Bausteinen für unterschiedliche Informationsformate je Thema.

Birgit Schäfer - Marketingmanager Leitz. Fordern Sie direkt ein Angebot an! Fordern Sie ein Angebot an.

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.