Schulung Technisches Schreiben für Entwickler und Ingenieure
•
1 gefällt mir•388 views
Auszüge aus einer Schulung bei evodion IT GmbH
Empfohlen
Empfohlen
Weitere ähnliche Inhalte
Ähnlich wie Schulung Technisches Schreiben für Entwickler und Ingenieure
Ähnlich wie Schulung Technisches Schreiben für Entwickler und Ingenieure (20)
Schulung Technisches Schreiben für Entwickler und Ingenieure
- 1. Schulung Technisches SchreibenOktober 2017 1 Schulung Technisches Schreiben Auszüge
- 2. Schulung Technisches SchreibenOktober 2017 2 Prinzipien des strukturierten Schreibens • Dokument = standardisierte Strukturen mit klar definierten Elementen • Jedes Element hat eine bestimmte Funktion • Strukturen sind auf verschiedenen Ebenen definiert • Qualitative und formale Festlegungen für Autoren • Standardisierte Erstellung und Produktion • Anwenderorientiertes Grundkonzept
- 3. Schulung Technisches SchreibenOktober 2017 3 Vorteile Hersteller: • Einfache und effiziente Dokumenterstellung • Konsistentere Dokumente • Kürzere Texte • Geringere Redundanz • Festgelegte Muster erzeugen mehr Vollständigkeit • Einfachere Wiederverwendung von Modulen Anwender: • Bessere Orientierung • Bessere Verständlichkeit • Mehr Akzeptanz
- 4. Schulung Technisches SchreibenOktober 2017 4 Sprechen (Schreiben) ist Handeln Jeder Satz hat eine Funktion (Intention). Die Funktion ist nicht immer ganz klar. Die Tür ist offen. Klarer Inhalt Erfolgreiche Kommunikation Feststellen, dass die Tür offen ist. Jmd. vorwerfen, dass dieser die Tür offen gelassen hat. Jmd. auffordern, die Tür zu schließen. Jmd. auffordern, zu gehen. Jmd. einladen hereinzukommen.
- 5. Schulung Technisches SchreibenOktober 2017 5 Was ist eine Persona? • Fiktive Person mit konkreten Eigenschaften und Nutzungsverhalten • Stellvertreter für tatsächliche Anwender • Hat konkrete Problemstellungen, z. B. bei der Computernutzung Personas helfen Autoren, anwenderorientierte Dokumentation zu schreiben Wichtige Richtlinien • Eine Persona muss die Charakteristiken von einer möglichen echten Person verkörpern, nicht statistische Werte (wie 1,2 Kinder) • Klare, detaillierte, kompakte Darstellung Persona-Technik
- 6. Schulung Technisches SchreibenOktober 2017 6 Benutzerorientiertes schreiben • Bei Auswahl der zu dokumentierenden Themen immer den Benutzer im Blick haben • Titel aus Sicht des Benutzers wählen, nicht aus Sicht des Systems • Titel an die Sprachebene der Benutzer anpassen • Aufmerksamkeit des Benutzers auf die Handlung lenken > aktive, direkte Verben wählen • Auf einleitende Abschnitte mit wenig oder ohne Relevanz für die Zielgruppe verzichten
- 7. Schulung Technisches SchreibenOktober 2017 7 Topictypen Topics haben eine bestimmte Funktion. Die grundsätzliche Funktionen sind: • Anweisen • Informieren • Fakten liefern Aufgabe (Anweisen) Verfahren Lehrreich Anwenderorientiert Konzept (Informieren) Beschreibend Hilft zu verstehen Hintergrundinformationen Referenz (Fakten liefern) Um Fakten nachzuschlagen Fensterbeschreibungen Einstellungen Werte
- 9. parson AG Chrysanderstr. 69A 21029 Hamburg +49 (0)40 7200 500-0 contact@parson-europe.com www.parson-europe.com
Hinweis der Redaktion
- + Sprecherhinweise: + Übliche Methoden zur Informationsklassifizierung * Funktionsdesign * Information Mapping© + Enthält kundenspezifischen Text/Abbildungen: Nein + Muss für Schulung angepasst werden: Nein + Anmerkungen: + [was bei vorherigen Schulungen aufgefallen ist, gibt es Varianten, Optimierungspotenzial usw.] + Typische Beispiele: + Referenzen: + Bildquelle: Ievgen Melamud – Fotolia.com
- + Sprecherhinweise: + [was der Trainer sagen soll, Lernziele] + Enthält kundenspezifischen Text/Abbildungen: Ja [Listen] + Muss für Schulung angepasst werden: Ja [Einführung der Liste sowie Stichpunkte an Kundenszenario anpassen] + Anmerkungen: + [was bei vorherigen Schulungen aufgefallen ist, gibt es Varianten, Optimierungspotenzial usw.] + Typische Beispiele: + Referenzen: + Bildquelle: Anatoly Maslennikov – Fotolia.com
- + Sprecherhinweise: + Trainees fragen, was für Funktionen sie sich vorstellen können? + Um die Intention zu verstehen, brauchen wir den Kontext. + Jedes Stück Information ist ohne Kontext unklar. + In der mündlichen Kommunikation kann man den Kontext leichter aus Körpersprache und vorangegangener Kommunikation schließen. + Schriftlich ist das schwieriger, muss expliziter sein. + Mögliche Kontexte: Informieren, Anweisen, Unterrichten, Fakten liefern, Emotionen ausdrücken, erlauben oder verbieten, anfordern + Enthält kundenspezifischen Text/Abbildungen: Nein + Muss für Schulung angepasst werden: Nein + Anmerkungen: Alternative Folieninhalte + andere Überschrift „Sprechakttheorie” und derzeitige Überschrift zusätzlich als Fließtext + Statt des roten Pfeils > die Funktion einer Satz zu kennen sichert eine erfolgreiche Kommunikation + Animation zunächst nur das Männlein, dann Frage an Schulungsteilnehmer und danach die Antworten einblenden + Typische Beispiele: +Referenzen: + Bildquelle: Anatoly Maslennikov – Fotolia.com
- Sprecherhinweise: Bisher haben wir immer von einer Zielgruppe gesprochen. Es ist jedoch schwer immer eine ganze Gruppe von Menschen vor Augen zu haben und alle Bedürfnisse zu beachten. Deshalb reduzieren wir nun auf einen Stereotyp, eine fiktive Person, die die wichtigsten Eigenschaft der Gruppe verkörpert. Personas basieren auf Erkenntnissen der Zielgruppenanalyse repräsentieren echte Nutzer In der Regel nutzt man sie, um bestimmte Probleme zu lösen, die echte Nutzer haben. Wie erstellt man aber nun Personas? möglichst realistische, detaillierte Beschreibung (Ergebnisse der Zielgruppenanalyse wie Umgang und ggf. Probleme mit dem Dokument in kompakter Form) keine statistischen Werte wie 1,3 Kinder, sondern Eigenschaften, die eine mögliche echte Person besitzen wie 1 Kind Grund: kein Mensch hat 1,3 Kinder Bild von echter Person zur Visualisierung der Persona, auch Skizze möglich Enthält kundenspezifischen Text/Abbildungen: Nein Muss für Schulung angepasst werden: Nein Anmerkungen: [was bei vorherigen Schulungen aufgefallen ist, gibt es Varianten, Optimierungspotenzial usw.] Typische Beispiele: Referenzen: Bildquelle: Anatoly Maslennikov – Fotolia.com
- Sprecherhinweise: [was der Trainer sagen soll, Lernziele] Enthält kundenspezifischen Text/Abbildungen: Nein Muss für Schulung angepasst werden: Nein Anmerkungen: [was bei vorherigen Schulungen aufgefallen ist, gibt es Varianten, Optimierungspotenzial usw.] Typische Beispiele: Referenzen: [Referenzinformationen, z.B. Websites, Hintergrundmaterial, Bildquellen]
- Sprecherhinweise: Konzept: beschreibende Information, die Anwender den Hintergrund und den Kontext eines Themas zu verstehen hilft. Referenz: detaillierte Fakten, die Anwender nachsehen. Referenztopics unterstützen die korrekte Durchführung der Aufgaben. Aufgabe: Verfahrensbeschreibung vom Absicht des Anwenders. Ein Topic ist ein obere Sequenzmuster. Es ist die praktische Anwendung eines Sequenzmusters. Wir haben einen festen Zweck und (wenn mit XML durchgeführt) eine feste Sequenz von funktionellen Inhalten (Elemente). Enthält kundenspezifischen Text/Abbildungen: Nein Muss für Schulung angepasst werden: Nein Anmerkungen: [was bei vorherigen Schulungen aufgefallen ist, gibt es Varianten, Optimierungspotenzial usw.] Typische Beispiele: Referenzen: Bildquelle: Männlein mit grüne Häckchen und Schreibtischstuhl: Anatoly Maslennikov – Fotolia.com Männlein mit Lupe: coramax – Fotolia.com