SlideShare ist ein Scribd-Unternehmen logo
SW-Benutzerhandbücher und Onlinehilfe – Single source?
Tekom RG Bodenseeraum, 14.05.2013
Blatt Nr. 1
Dr. Rainer Pflaum, SysKon
Wer sind wir?Wer sind wir?
Ein bunt gemischtes Team ausEin bunt gemischtes Team aus
NaturwissenschaftlernNaturwissenschaftlern
InformatikernInformatikern
IngenieurenIngenieuren
ProjektleiternProjektleitern
Technischen RedakteurenTechnischen Redakteuren
StudentenStudenten
SW-Benutzerhandbücher und Onlinehilfe – Single source?
Tekom RG Bodenseeraum, 14.05.2013
Blatt Nr. 2
Dr. Rainer Pflaum, SysKon
Wo arbeiten und leben wir?Wo arbeiten und leben wir?
SW-Benutzerhandbücher und Onlinehilfe – Single source?
Tekom RG Bodenseeraum, 14.05.2013
Blatt Nr. 3
Dr. Rainer Pflaum, SysKon
PrPrääziser:ziser:
Wir arbeiten oft bei Siemens (I Mo ILWir arbeiten oft bei Siemens (I Mo IL -- Postautomation)Postautomation)
SW-Benutzerhandbücher und Onlinehilfe – Single source?
Tekom RG Bodenseeraum, 14.05.2013
Blatt Nr. 4
Dr. Rainer Pflaum, SysKon
... oder in unseren R... oder in unseren Rääumenumen
... oder bei anderen Kunden... oder bei anderen Kunden
... wie ND... wie ND SatComSatCom (Immenstaad)(Immenstaad)
SW-Benutzerhandbücher und Onlinehilfe – Single source?
Tekom RG Bodenseeraum, 14.05.2013
Blatt Nr. 5
Dr. Rainer Pflaum, SysKon
Was tun wir?Was tun wir?
Wir unterstWir unterstüützen unsere Kunden beitzen unsere Kunden bei
Technischer RedaktionTechnischer Redaktion
ProjektleitungProjektleitung
ProzessdesignProzessdesign
Programmieren von Tools, Makros, ...Programmieren von Tools, Makros, ...
Anpassungen des RedaktionssystemsAnpassungen des Redaktionssystems
Sonstigen technischen Fragen rund umsSonstigen technischen Fragen rund ums
InformationsmanagementInformationsmanagement
SW-Benutzerhandbücher und Onlinehilfe – Single source?
Tekom RG Bodenseeraum, 14.05.2013
Blatt Nr. 6
Dr. Rainer Pflaum, SysKon
Beispiele Redaktion PostautomationBeispiele Redaktion Postautomation
FlatsFlats SortingSorting System (FSS, 2000System (FSS, 2000--),),
Open Mail Sorter (OMS, 2005Open Mail Sorter (OMS, 2005--))
Modularisierung des GesamtsystemsModularisierung des Gesamtsystems
Wartungskonzept erstellenWartungskonzept erstellen
OEMOEM--Dokumentation integrierenDokumentation integrieren
Sicherheitskonzept integrierenSicherheitskonzept integrieren
Diverse Module und Anlagen (1990Diverse Module und Anlagen (1990--))
InstandhaltungsdokumentationInstandhaltungsdokumentation
SoftwareSoftware--BenutzerhandbBenutzerhandbüüchercher
InstallationsdokumentationInstallationsdokumentation
BedienungsanleitungenBedienungsanleitungen
SW-Benutzerhandbücher und Onlinehilfe – Single source?
Tekom RG Bodenseeraum, 14.05.2013
Blatt Nr. 7
Dr. Rainer Pflaum, SysKon
Gliederung des heutigen VortragsGliederung des heutigen Vortrags
AnforderungenAnforderungen
DIN EN 62079DIN EN 62079
SWSW--BenutzerhandbBenutzerhandbüüchercher
OnlinehilfeOnlinehilfe
Unterschiede und GemeinsamkeitenUnterschiede und Gemeinsamkeiten
SingleSingle sourcesource ffüürr PrintPrint und Onlineund Online
Trennung von Inhalt und Seitenlayout,Trennung von Inhalt und Seitenlayout,
RedaktionssystemRedaktionssystem
Medienneutrale RedaktionMedienneutrale Redaktion
AusgewAusgewäählte Beispiele mit Schema ST4hlte Beispiele mit Schema ST4
AusgewAusgewäählte Beispiele mit TIMhlte Beispiele mit TIM--RSRS
SW-Benutzerhandbücher und Onlinehilfe – Single source?
Tekom RG Bodenseeraum, 14.05.2013
Blatt Nr. 8
Dr. Rainer Pflaum, SysKon
DIN EN 62079DIN EN 62079 (aktueller g(aktueller güültiger Stand: 11/2001)ltiger Stand: 11/2001)
Erstellen von Anleitungen: Gliederung, Inhalt und DarstellungErstellen von Anleitungen: Gliederung, Inhalt und Darstellung
Funktionen der NormFunktionen der Norm
detailliert die Anforderungen der EUdetailliert die Anforderungen der EU--Maschinenrichtlinie 98/37/EU undMaschinenrichtlinie 98/37/EU und
weitet gleichzeitig den Stand der Technik des Anlagenweitet gleichzeitig den Stand der Technik des Anlagen-- undund
Maschinenbaus auf alle Produkte und Dienstleistungen ausMaschinenbaus auf alle Produkte und Dienstleistungen aus
setzt qualitative und quantitative Mindeststandards fsetzt qualitative und quantitative Mindeststandards füür technischer technische
Informationsmedien (auch elektronische)Informationsmedien (auch elektronische)
ChecklistenChecklisten (Zentraler Punkt: Vollst(Zentraler Punkt: Vollstäändigkeit)ndigkeit)
Technische Richtigkeit (Anhang B)Technische Richtigkeit (Anhang B)
DarstellungsDarstellungsüüberprberprüüfung (Anhang C)fung (Anhang C)
BeispielBeispiel--Inhaltsverzeichnis (Anhang D)Inhaltsverzeichnis (Anhang D)
sind kostenlos im Internet herunterladbar und frei verwendbarsind kostenlos im Internet herunterladbar und frei verwendbar
ersetzen nicht den gut ausgebildeten und fachlich versiertenersetzen nicht den gut ausgebildeten und fachlich versierten
Technischen RedakteurTechnischen Redakteur
Nationale FuNationale Fußßnote:note:
Diese Checkliste darf zur technischenDiese Checkliste darf zur technischen ÜÜberprberprüüfung von Anleitungenfung von Anleitungen
gebgebüührenfrei vervielfhrenfrei vervielfäältigt werden bzw. kann kostenfrei heruntergeladenltigt werden bzw. kann kostenfrei heruntergeladen
werden von:werden von:
http://www.dke.de/de/facharbeit/mitteilungen/62079check.htmhttp://www.dke.de/de/facharbeit/mitteilungen/62079check.htm
SW-Benutzerhandbücher und Onlinehilfe – Single source?
Tekom RG Bodenseeraum, 14.05.2013
Blatt Nr. 9
Dr. Rainer Pflaum, SysKon
DIN EN 62079DIN EN 62079 –– GrundsGrundsäätze (Abs. 4)tze (Abs. 4)
4.1 Anleitung ist Teil des Produkts4.1 Anleitung ist Teil des Produkts
Anleitungen sind ein integraler Bestandteil derAnleitungen sind ein integraler Bestandteil der
Produktlieferung. Sie mProduktlieferung. Sie müüssen den korrekten Gebrauch einesssen den korrekten Gebrauch eines
Produkts erlauben und fProdukts erlauben und föördern.rdern.
Der Informationsgehalt der Anleitung muss alle erwartetenDer Informationsgehalt der Anleitung muss alle erwarteten
Pflichten des Benutzers abdecken. Daher hPflichten des Benutzers abdecken. Daher häängt der Inhaltngt der Inhalt
von der Art der Lieferung ab. Falls z. B. die Errichtung undvon der Art der Lieferung ab. Falls z. B. die Errichtung und
Inbetriebnahme Bestandteil der Lieferung sind, erhInbetriebnahme Bestandteil der Lieferung sind, erhäält derlt der
Benutzer in den Anleitungen lediglich InformationenBenutzer in den Anleitungen lediglich Informationen üüberber
den Betrieb und die Instandhaltung.den Betrieb und die Instandhaltung.
SW-Benutzerhandbücher und Onlinehilfe – Single source?
Tekom RG Bodenseeraum, 14.05.2013
Blatt Nr. 10
Dr. Rainer Pflaum, SysKon
Anforderungen an SWAnforderungen an SW--BenutzerhandbBenutzerhandbüüchercher
DarstellungsDarstellungsüüberprberprüüfung nach DIN EN 62079fung nach DIN EN 62079 (Kap. 6, eine Auswahl)(Kap. 6, eine Auswahl)
Erst lesen, dann handelnErst lesen, dann handeln
Wahrscheinliche Reihenfolge der Ereignisse beim Gebrauch des ProWahrscheinliche Reihenfolge der Ereignisse beim Gebrauch des Produktsdukts
definiert Reihenfolge des Textes.definiert Reihenfolge des Textes.
Stetig verbessertes VerstehenStetig verbessertes Verstehen
Wenn fWenn füür einen sicheren und korrekten Gebrauch des Produktsr einen sicheren und korrekten Gebrauch des Produkts
sequentiellen Ablsequentiellen Ablääufen gefolgt werden muss, mufen gefolgt werden muss, müüssen die Anleitungen denssen die Anleitungen den
Benutzer befBenutzer befäähigen und ermutigen, einem stetigen Lernhigen und ermutigen, einem stetigen Lern-- undund
Verstehensprozess zu folgen (Hilfreich: Abbildungen, Tabellen,Verstehensprozess zu folgen (Hilfreich: Abbildungen, Tabellen,
Diagramme).Diagramme).
Einfach und kurzEinfach und kurz
so einfach und kurz wie möglich, in konsistenten Fachbegriffen und
Einheiten formuliert, mit einer klaren Erklärung unüblicher technischer
Fachbegriffe.
Benutzerfragen vorwegnehmenBenutzerfragen vorwegnehmen
Anleitungen mAnleitungen müüssen die Benutzerfragen Wo? Wer? Was? Wann? Wie?ssen die Benutzerfragen Wo? Wer? Was? Wann? Wie?
Warum? vorwegnehmen und Antworten darauf liefern.Warum? vorwegnehmen und Antworten darauf liefern.
Ein Satz, eine HandlungsanweisungEin Satz, eine Handlungsanweisung
Ein Satz darf nur eine Handlungsanweisung enthalten oder hEin Satz darf nur eine Handlungsanweisung enthalten oder hööchstens einechstens eine
kleine Anzahl eng verbundener Handlungsanweisungen.kleine Anzahl eng verbundener Handlungsanweisungen.
...... uvmuvm..
SW-Benutzerhandbücher und Onlinehilfe – Single source?
Tekom RG Bodenseeraum, 14.05.2013
Blatt Nr. 11
Dr. Rainer Pflaum, SysKon
Anforderungen an SWAnforderungen an SW--BenutzerhandbBenutzerhandbüüchercher
DarstellungsDarstellungsüüberprberprüüfung nach DIN EN 62079fung nach DIN EN 62079 (Kap. 6, auszugsweise)(Kap. 6, auszugsweise)
Leserlichkeit / Schriftart und GrLeserlichkeit / Schriftart und Größößee
... gr... größößtmtmöögliche Leserlichkeit sicherstellen,gliche Leserlichkeit sicherstellen,
... Flie... Fließßtext nicht kleiner als 9text nicht kleiner als 9 PicaPica Punkte.Punkte.
AbbildungenAbbildungen
auf Qualitauf Qualitäät und Klarheit achten, medienunabht und Klarheit achten, medienunabhäängigngig
... Text und Abbildung zusammen anwenden... Text und Abbildung zusammen anwenden
... eine Abbildung = eine Informationseinheit... eine Abbildung = eine Informationseinheit
Grafische SymboleGrafische Symbole
...... müssen anerkannten Normen folgen
...... müssen in den Anleitungen erklärt sein ...
TabellenTabellen
... wo diese das Verst... wo diese das Verstäändnis fndnis föördernrdern
... angrenzend an den zugeh... angrenzend an den zugehöörigen Textrigen Text
... Wiederholen wo n... Wiederholen wo nöötig.tig.
WarnhinweiseWarnhinweise
... Hervorheben,... Hervorheben, zum richtigen Zeitpunkt sichtbarzum richtigen Zeitpunkt sichtbar
... gib klare Anweisungen, was zu tun ist... gib klare Anweisungen, was zu tun ist
... gib klare Anweisungen, was zu vermeiden ist. ...... gib klare Anweisungen, was zu vermeiden ist. ...
...... uvmuvm..
SW-Benutzerhandbücher und Onlinehilfe – Single source?
Tekom RG Bodenseeraum, 14.05.2013
Blatt Nr. 12
Dr. Rainer Pflaum, SysKon
In welchen Situationen wird die Hilfe geIn welchen Situationen wird die Hilfe geööffnet?ffnet?
Start einer AufgabeStart einer Aufgabe
Fehlen erwarteter FunktionenFehlen erwarteter Funktionen
Ganz allgemeinGanz allgemein ……
Online und HilfeOnline und Hilfe
SW-Benutzerhandbücher und Onlinehilfe – Single source?
Tekom RG Bodenseeraum, 14.05.2013
Blatt Nr. 13
Dr. Rainer Pflaum, SysKon
Anforderungen OnlinehilfeAnforderungen Onlinehilfe
Der Nutzer sucht beim Aufruf der OnlinehilfeDer Nutzer sucht beim Aufruf der Onlinehilfe
Antwort auf die FrageAntwort auf die Frage „„Wie geht es nun weiter?Wie geht es nun weiter?““
Daraus ergeben sich Anforderungen wieDaraus ergeben sich Anforderungen wie
Kontextsensitive HilfeKontextsensitive Hilfe
Separates HilfefensterSeparates Hilfefenster
Kompakte Hilfethemen, Scrollen mKompakte Hilfethemen, Scrollen mööglichst vermeidenglichst vermeiden
VerstVerstäändnis der aktuellen Funktionndnis der aktuellen Funktion
AnwendungsfAnwendungsfäällelle
VerstVerstäändnis der Prozessendnis der Prozesse
SW-Benutzerhandbücher und Onlinehilfe – Single source?
Tekom RG Bodenseeraum, 14.05.2013
Blatt Nr. 14
Dr. Rainer Pflaum, SysKon
Unterschiede, GemeinsamkeitenUnterschiede, Gemeinsamkeiten
Was aus dem Handbuch ist onlineWas aus dem Handbuch ist online üüberflberflüüssig?ssig?
Anweisungen zum Installieren der SoftwareAnweisungen zum Installieren der Software
Was wird online zusWas wird online zusäätzlich bentzlich benöötigt?tigt?
Anweisungen zum Bedienen der OnlineAnweisungen zum Bedienen der Online--HilfeHilfe
--> SW> SW--InstallationshandbInstallationshandbüüchercher
Der Rest wird fDer Rest wird füür beide Medien benr beide Medien benöötigt!tigt!
... sofern er redaktionell optimiert ist... sofern er redaktionell optimiert ist
Unterschiede: Seitenlayout, ReferenzenUnterschiede: Seitenlayout, Referenzen
SW-Benutzerhandbücher und Onlinehilfe – Single source?
Tekom RG Bodenseeraum, 14.05.2013
Blatt Nr. 15
Dr. Rainer Pflaum, SysKon
GemeinsamkeitenGemeinsamkeiten –– Redaktion / RechercheRedaktion / Recherche
Alle Informationen zusammentragenAlle Informationen zusammentragen
SpezifikationenSpezifikationen
Software in AktionSoftware in Aktion
Entwickler oder andere Experten befragenEntwickler oder andere Experten befragen
per Eper E--MailMail
telefonischtelefonisch
perspersöönliches Gesprnliches Gespräächch
Wichtig: Fragen Sie so lange,Wichtig: Fragen Sie so lange,
bis Sie esbis Sie es wirklichwirklich verstanden haben.verstanden haben.
SW-Benutzerhandbücher und Onlinehilfe – Single source?
Tekom RG Bodenseeraum, 14.05.2013
Blatt Nr. 16
Dr. Rainer Pflaum, SysKon
GemeinsamkeitenGemeinsamkeiten –– Text erstellenText erstellen
Ich habe keine ZeitIch habe keine Zeit
Ihnen einen kurzen Brief zu schreiben,Ihnen einen kurzen Brief zu schreiben,
deshalb schreibe ich einen langen.deshalb schreibe ich einen langen.
Erstellen guter Texte:Erstellen guter Texte:
aus vielen korrekten Waus vielen korrekten Wöörtern das genau treffendertern das genau treffende
Wort auswWort auswäählenhlen
von den syntaktisch korrekten Varianten die einevon den syntaktisch korrekten Varianten die eine
nutzen, die den Leser besonders ansprichtnutzen, die den Leser besonders anspricht
die Botschaft des Auftraggebersdie Botschaft des Auftraggebers üübermitteln und diebermitteln und die
Regeln der CorporateRegeln der Corporate IdentityIdentity (CI) beachten !(CI) beachten !
SW-Benutzerhandbücher und Onlinehilfe – Single source?
Tekom RG Bodenseeraum, 14.05.2013
Blatt Nr. 17
Dr. Rainer Pflaum, SysKon
GemeinsamkeitenGemeinsamkeiten –– Text erstellenText erstellen
WertschWertschööpfung durch gute Texte:pfung durch gute Texte:
wirkt auf das Imagewirkt auf das Image
Image spricht sich herumImage spricht sich herum
EntscheidungskritieriumEntscheidungskritierium bei gleicher Qualitbei gleicher Qualitäätt
KundenzufriedenheitKundenzufriedenheit
weniger Nachfragen und Beschwerdenweniger Nachfragen und Beschwerden
weniger Gewweniger Gewäährleistungsansprhrleistungsansprüücheche
Also:Also:
Professionelles DeutschProfessionelles Deutsch
Kontrolliertes DeutschKontrolliertes Deutsch
SW-Benutzerhandbücher und Onlinehilfe – Single source?
Tekom RG Bodenseeraum, 14.05.2013
Blatt Nr. 18
Dr. Rainer Pflaum, SysKon
GemeinsamkeitenGemeinsamkeiten –– Text erstellenText erstellen
Zu den Kompetenzen des technischen Redakteurs gehZu den Kompetenzen des technischen Redakteurs gehöört:rt:
Informationen verstInformationen verstäändlich aufbereitenndlich aufbereiten
VerstVerstäändlichkeit von Texten beurteilenndlichkeit von Texten beurteilen
TextschwTextschwäächen erkennen und behebenchen erkennen und beheben
Eine leicht verstEine leicht verstäändliche Sprache anzuwendenndliche Sprache anzuwenden
bedeutet nicht mangelnde Bildung!bedeutet nicht mangelnde Bildung!
Gut, kurz und vollstGut, kurz und vollstäändig zu (ndig zu (bebe--)schreiben)schreiben
ist ein Handwerk, das vor allem geist ein Handwerk, das vor allem geüübt sein will.bt sein will.
SW-Benutzerhandbücher und Onlinehilfe – Single source?
Tekom RG Bodenseeraum, 14.05.2013
Blatt Nr. 19
Dr. Rainer Pflaum, SysKon
GemeinsamkeitenGemeinsamkeiten –– Text erstellenText erstellen
Es gibt zwei Sorten Menschen:Es gibt zwei Sorten Menschen:
die einen schreiben gut unddie einen schreiben gut und
trauen sich aber nicht an Technik herantrauen sich aber nicht an Technik heran
die anderen verstehen die Technik,die anderen verstehen die Technik,
kköönnen es aber nicht verstnnen es aber nicht verstäändlich beschreibenndlich beschreiben
„„Papa, wozu gehPapa, wozu gehöören dann die technischen Redakteure?ren dann die technischen Redakteure?““::
dreidrei
Fazit:Fazit:
DurchDurch SingleSingle sourcesource Zeit gewinnen fZeit gewinnen füürr
die Kernaufgaben der Redaktion!die Kernaufgaben der Redaktion!
SW-Benutzerhandbücher und Onlinehilfe – Single source?
Tekom RG Bodenseeraum, 14.05.2013
Blatt Nr. 20
Dr. Rainer Pflaum, SysKon
UnterschiedeUnterschiede –– Grafiken erstellenGrafiken erstellen
Grafiken in Anleitungen:Grafiken in Anleitungen:
erherhööhen die Versthen die Verstäändlichkeit, wenn siendlichkeit, wenn sie
eng beim zugeheng beim zugehöörigen Text stehenrigen Text stehen
die wesentlichen Zusammenhdie wesentlichen Zusammenhäänge sofort deutlichnge sofort deutlich
erkennen lassenerkennen lassen
PrintPrint:: ScreenshotsScreenshots 1:1, Fotos 3001:1, Fotos 300 dpidpi
Online: Max. ca. 700 Pixel breit, Exporte 120Online: Max. ca. 700 Pixel breit, Exporte 120 dpidpi,, AntialiasAntialias
BspBsp: PNG, 256 Farben, verlustfrei,: PNG, 256 Farben, verlustfrei,
1827x1074, 189KB1827x1074, 189KB
SW-Benutzerhandbücher und Onlinehilfe – Single source?
Tekom RG Bodenseeraum, 14.05.2013
Blatt Nr. 21
Dr. Rainer Pflaum, SysKon
GemeinsamkeitenGemeinsamkeiten –– Grafiken erstellenGrafiken erstellen
Grafiken in Anleitungen: DerGrafiken in Anleitungen: Der JPGJPG--EffektEffekt
JPG ist ein prima Kompressionsalgorithmus fJPG ist ein prima Kompressionsalgorithmus füürr
Fotos, aber erzeugt zwangsweiseFotos, aber erzeugt zwangsweise schmutzigeschmutzige
Wolken bei allen vollfarbigen ObjektenWolken bei allen vollfarbigen Objekten wiewie
ScreenshotsScreenshots (au(außßer sie zeigen Fotos/Videos)er sie zeigen Fotos/Videos)
Nummern in FotosNummern in Fotos
ZeichnungenZeichnungen
SW-Benutzerhandbücher und Onlinehilfe – Single source?
Tekom RG Bodenseeraum, 14.05.2013
Blatt Nr. 22
Dr. Rainer Pflaum, SysKon
GemeinsamkeitenGemeinsamkeiten –– SicherheitshinweiseSicherheitshinweise
ANSI Z 535.6ANSI Z 535.6 (U.S.(U.S.--Standard)Standard) -- eben noch exotisch, jetzt auch bei dereben noch exotisch, jetzt auch bei der TekomTekom ::
Keine separate Auszeichnung vonKeine separate Auszeichnung von
MaschinenschMaschinenschääden, Datenverlust etcden, Datenverlust etc
mehr!mehr!
SW-Benutzerhandbücher und Onlinehilfe – Single source?
Tekom RG Bodenseeraum, 14.05.2013
Blatt Nr. 23
Dr. Rainer Pflaum, SysKon
GemeinsamkeitenGemeinsamkeiten –– SicherheitshinweiseSicherheitshinweise
Wie kann man auf das gute alteWie kann man auf das gute alte „„AchtungAchtung““ verzichten?verzichten?
Gefahr der
Zerstörung der
Anlage
Gefahr des
Daten-
verlusts
Missachtung von
Hinweisen kostet unnötige
Techniker-Zeit
All dies sind mögliche
pekuniäre Schäden, also
Unwichtige Informationen gibt
es nicht in unserer Anleitung!
SW-Benutzerhandbücher und Onlinehilfe – Single source?
Tekom RG Bodenseeraum, 14.05.2013
Blatt Nr. 24
Dr. Rainer Pflaum, SysKon
RedaktionssystemRedaktionssystem –– Inhalt und LayoutInhalt und Layout
mediengerecht trennenmediengerecht trennen
Produktionen einer Information/DokumentationProduktionen einer Information/Dokumentation
EinsparpotenzialEinsparpotenzial
nutzen!nutzen!
Variante
A
B
C
Sprache
EnglischDeutschSpanisch
Format
Print Help Internet
©SCHEMAGmbH
SW-Benutzerhandbücher und Onlinehilfe – Single source?
Tekom RG Bodenseeraum, 14.05.2013
Blatt Nr. 25
Dr. Rainer Pflaum, SysKon
UnterschiedeUnterschiede –– SeitenlayoutSeitenlayout
Thema:Thema:
PrintPrint::
Online:Online:
SW-Benutzerhandbücher und Onlinehilfe – Single source?
Tekom RG Bodenseeraum, 14.05.2013
Blatt Nr. 26
Dr. Rainer Pflaum, SysKon
UnterschiedeUnterschiede –– QuerverweiseQuerverweise
Konfiguration:Konfiguration:
PrintPrint::
Online:Online:
SW-Benutzerhandbücher und Onlinehilfe – Single source?
Tekom RG Bodenseeraum, 14.05.2013
Blatt Nr. 27
Dr. Rainer Pflaum, SysKon
OnlinehilfeOnlinehilfe –– kontextsensitiv, Bsp. ST4kontextsensitiv, Bsp. ST4
Konfiguration:Konfiguration:
Dateien:Dateien:
Einsprung:Einsprung:
SW-Benutzerhandbücher und Onlinehilfe – Single source?
Tekom RG Bodenseeraum, 14.05.2013
Blatt Nr. 28
Dr. Rainer Pflaum, SysKon
OnlinehilfeOnlinehilfe –– kontextsensitiv, Bsp. TIMkontextsensitiv, Bsp. TIM--RSRS
EinsprungEinsprung
KonfigurationKonfiguration
SW-Benutzerhandbücher und Onlinehilfe – Single source?
Tekom RG Bodenseeraum, 14.05.2013
Blatt Nr. 29
Dr. Rainer Pflaum, SysKon
OnlinehilfeOnlinehilfe –– kontextsensitiv, Bsp. PDFkontextsensitiv, Bsp. PDF
Anleitung zur Konfiguration bei Adobe:Anleitung zur Konfiguration bei Adobe:
www.adobe.com/devnet/acrobat/pdfs/www.adobe.com/devnet/acrobat/pdfs/
pdf_open_parameters.pdfpdf_open_parameters.pdf
Beispielaufruf mit Seite 7:Beispielaufruf mit Seite 7:
AcroRD32.exe /A "page=7"AcroRD32.exe /A "page=7" c:c:temptemptest.pdftest.pdf
SW-Benutzerhandbücher und Onlinehilfe – Single source?
Tekom RG Bodenseeraum, 14.05.2013
Blatt Nr. 30
Dr. Rainer Pflaum, SysKon
Vielen DankVielen Dank
ffüür Ihre Aufmerksamkeit!r Ihre Aufmerksamkeit!

Weitere ähnliche Inhalte

Andere mochten auch

El baloncesto
El baloncestoEl baloncesto
El baloncesto
tottical
 
Mis deberes y derechos como aprendiz SENA.
Mis deberes y derechos como aprendiz SENA.  Mis deberes y derechos como aprendiz SENA.
Mis deberes y derechos como aprendiz SENA.
eazh
 
Presentación Geometria
Presentación GeometriaPresentación Geometria
Presentación Geometria
Diego Garcia
 
M3 s4 matriz tpack para el diseño de actividades mejorada
M3 s4 matriz tpack para el diseño de actividades mejoradaM3 s4 matriz tpack para el diseño de actividades mejorada
M3 s4 matriz tpack para el diseño de actividades mejorada
Cabatics
 
10 gruende-dein-unternehmen-zu-starten
10 gruende-dein-unternehmen-zu-starten10 gruende-dein-unternehmen-zu-starten
10 gruende-dein-unternehmen-zu-starten
Friedrich Hoepfner
 
Manual de pontif. univ. de valparaiso
Manual de pontif. univ. de valparaisoManual de pontif. univ. de valparaiso
Manual de pontif. univ. de valparaiso
lesliefiore
 
Balonmano (Xènia y Noèlia)
Balonmano (Xènia y Noèlia)Balonmano (Xènia y Noèlia)
Balonmano (Xènia y Noèlia)
tottical
 
Carlos ruiz
Carlos ruizCarlos ruiz
Carlos ruiz
carliins
 
Luis y german robotica
Luis y german roboticaLuis y german robotica
Luis y german robotica
Lauraperla18RuizValian
 
Presentacion grupal mapas mentales
Presentacion grupal mapas mentalesPresentacion grupal mapas mentales
Presentacion grupal mapas mentales
Angietinjaca
 
Fabian figueroa grupo 35
Fabian figueroa grupo 35Fabian figueroa grupo 35
Fabian figueroa grupo 35
FABIÁN FIGUEROA
 

Andere mochten auch (16)

El baloncesto
El baloncestoEl baloncesto
El baloncesto
 
Mis deberes y derechos como aprendiz SENA.
Mis deberes y derechos como aprendiz SENA.  Mis deberes y derechos como aprendiz SENA.
Mis deberes y derechos como aprendiz SENA.
 
Presentación Geometria
Presentación GeometriaPresentación Geometria
Presentación Geometria
 
M3 s4 matriz tpack para el diseño de actividades mejorada
M3 s4 matriz tpack para el diseño de actividades mejoradaM3 s4 matriz tpack para el diseño de actividades mejorada
M3 s4 matriz tpack para el diseño de actividades mejorada
 
X-mas
X-masX-mas
X-mas
 
10 gruende-dein-unternehmen-zu-starten
10 gruende-dein-unternehmen-zu-starten10 gruende-dein-unternehmen-zu-starten
10 gruende-dein-unternehmen-zu-starten
 
Manual de pontif. univ. de valparaiso
Manual de pontif. univ. de valparaisoManual de pontif. univ. de valparaiso
Manual de pontif. univ. de valparaiso
 
Balonmano (Xènia y Noèlia)
Balonmano (Xènia y Noèlia)Balonmano (Xènia y Noèlia)
Balonmano (Xènia y Noèlia)
 
Binder1
Binder1Binder1
Binder1
 
Fachliche Vernetzung von Repositories auf europäischer Ebene - das Beispiel N...
Fachliche Vernetzung von Repositories auf europäischer Ebene - das Beispiel N...Fachliche Vernetzung von Repositories auf europäischer Ebene - das Beispiel N...
Fachliche Vernetzung von Repositories auf europäischer Ebene - das Beispiel N...
 
2008 06 payoff magazine
2008 06 payoff magazine2008 06 payoff magazine
2008 06 payoff magazine
 
Carlos ruiz
Carlos ruizCarlos ruiz
Carlos ruiz
 
Luis y german robotica
Luis y german roboticaLuis y german robotica
Luis y german robotica
 
Presentacion grupal mapas mentales
Presentacion grupal mapas mentalesPresentacion grupal mapas mentales
Presentacion grupal mapas mentales
 
2008 05 payoff magazine
2008 05 payoff magazine2008 05 payoff magazine
2008 05 payoff magazine
 
Fabian figueroa grupo 35
Fabian figueroa grupo 35Fabian figueroa grupo 35
Fabian figueroa grupo 35
 

Ähnlich wie SW-Benutzerhandbuch und Onlinehilfe aus einer Quelle

IEC/DIS 82079-1 - Martin Galbierz
IEC/DIS 82079-1 - Martin GalbierzIEC/DIS 82079-1 - Martin Galbierz
IEC/DIS 82079-1 - Martin Galbierztecom
 
News zur entstaubung infa aktuell 2-2013
News zur entstaubung infa aktuell 2-2013News zur entstaubung infa aktuell 2-2013
News zur entstaubung infa aktuell 2-2013
Infastaub GmbH
 
Executive Summary - German
Executive Summary - GermanExecutive Summary - German
Executive Summary - German
Shumin Chen
 
Kongress Instandhaltung mit SAP PM 2018
Kongress Instandhaltung mit SAP PM 2018Kongress Instandhaltung mit SAP PM 2018
Kongress Instandhaltung mit SAP PM 2018
RODIAS GmbH
 
Katalog spannverbindungen 11_03_2013
Katalog spannverbindungen 11_03_2013Katalog spannverbindungen 11_03_2013
Katalog spannverbindungen 11_03_2013Europages2
 
IFC Ebert Tagung Instandhaltung 2015
IFC Ebert Tagung Instandhaltung 2015IFC Ebert Tagung Instandhaltung 2015
IFC Ebert Tagung Instandhaltung 2015
MCP Deutschland GmbH
 
IFC Ebert Tagung Instandhaltung 2015
IFC Ebert Tagung Instandhaltung 2015IFC Ebert Tagung Instandhaltung 2015
IFC Ebert Tagung Instandhaltung 2015
dankl+partner consulting gmbh
 
Seminar: Konstruktion und Dimensionierung mit Faserverbundwerkstoffen im Masc...
Seminar: Konstruktion und Dimensionierung mit Faserverbundwerkstoffen im Masc...Seminar: Konstruktion und Dimensionierung mit Faserverbundwerkstoffen im Masc...
Seminar: Konstruktion und Dimensionierung mit Faserverbundwerkstoffen im Masc...
stzepm
 
Von der Lähmschicht zur Schwungmasse
Von der Lähmschicht zur SchwungmasseVon der Lähmschicht zur Schwungmasse
Von der Lähmschicht zur Schwungmasse
Learning Factory
 
14. TANNER-Hochschulwettbewerb | Beitrag Team Yu (Hochschule Merseburg)
 14. TANNER-Hochschulwettbewerb | Beitrag Team Yu (Hochschule Merseburg) 14. TANNER-Hochschulwettbewerb | Beitrag Team Yu (Hochschule Merseburg)
14. TANNER-Hochschulwettbewerb | Beitrag Team Yu (Hochschule Merseburg)
TANNER AG
 
WIFI-Lehrgang Instandhaltungstechnologien mit Zukunft
WIFI-Lehrgang Instandhaltungstechnologien mit ZukunftWIFI-Lehrgang Instandhaltungstechnologien mit Zukunft
WIFI-Lehrgang Instandhaltungstechnologien mit Zukunft
dankl+partner consulting gmbh
 
PDM Open Hours - Aufbau, Verwendung und Pflege von Bennennungskatalogen
PDM Open Hours - Aufbau, Verwendung und Pflege von BennennungskatalogenPDM Open Hours - Aufbau, Verwendung und Pflege von Bennennungskatalogen
PDM Open Hours - Aufbau, Verwendung und Pflege von Bennennungskatalogen
Intelliact AG
 
Dokumentation in der Realität des Anlagenbaus - Hansruedi Steinhauer
Dokumentation in der Realität des Anlagenbaus - Hansruedi SteinhauerDokumentation in der Realität des Anlagenbaus - Hansruedi Steinhauer
Dokumentation in der Realität des Anlagenbaus - Hansruedi Steinhauertecom
 
Professionelle Anforderungsanalyse am Beispiel einer Java-Anwendung zur Betri...
Professionelle Anforderungsanalyse am Beispiel einer Java-Anwendung zur Betri...Professionelle Anforderungsanalyse am Beispiel einer Java-Anwendung zur Betri...
Professionelle Anforderungsanalyse am Beispiel einer Java-Anwendung zur Betri...
GFU Cyrus AG
 
12. TANNER-Hochschulwettbewerb | Beitrag Team Schildberg (Karlsruher Institut...
12. TANNER-Hochschulwettbewerb | Beitrag Team Schildberg (Karlsruher Institut...12. TANNER-Hochschulwettbewerb | Beitrag Team Schildberg (Karlsruher Institut...
12. TANNER-Hochschulwettbewerb | Beitrag Team Schildberg (Karlsruher Institut...
TANNER AG
 
MC4 Multi Contact Solar Connector
MC4 Multi Contact Solar ConnectorMC4 Multi Contact Solar Connector
MC4 Multi Contact Solar Connector
Thorne & Derrick International
 
Laser symposium 2018. dresden alemania.- programa general
Laser symposium 2018.  dresden alemania.- programa generalLaser symposium 2018.  dresden alemania.- programa general
Laser symposium 2018. dresden alemania.- programa general
Grupo Idemet SA de CV
 
Waelzholz 201510-de
Waelzholz 201510-deWaelzholz 201510-de
Waelzholz 201510-de
CarolinFinke
 
Empfehlung zu Gefahrstoffen 409: „Nutzung von REACH-Informationen für den Arb...
Empfehlung zu Gefahrstoffen 409: „Nutzung von REACH-Informationen für den Arb...Empfehlung zu Gefahrstoffen 409: „Nutzung von REACH-Informationen für den Arb...
Empfehlung zu Gefahrstoffen 409: „Nutzung von REACH-Informationen für den Arb...
BDI
 

Ähnlich wie SW-Benutzerhandbuch und Onlinehilfe aus einer Quelle (20)

IEC/DIS 82079-1 - Martin Galbierz
IEC/DIS 82079-1 - Martin GalbierzIEC/DIS 82079-1 - Martin Galbierz
IEC/DIS 82079-1 - Martin Galbierz
 
News zur entstaubung infa aktuell 2-2013
News zur entstaubung infa aktuell 2-2013News zur entstaubung infa aktuell 2-2013
News zur entstaubung infa aktuell 2-2013
 
Executive Summary - German
Executive Summary - GermanExecutive Summary - German
Executive Summary - German
 
Kongress Instandhaltung mit SAP PM 2018
Kongress Instandhaltung mit SAP PM 2018Kongress Instandhaltung mit SAP PM 2018
Kongress Instandhaltung mit SAP PM 2018
 
Katalog spannverbindungen 11_03_2013
Katalog spannverbindungen 11_03_2013Katalog spannverbindungen 11_03_2013
Katalog spannverbindungen 11_03_2013
 
IFC Ebert Tagung Instandhaltung 2015
IFC Ebert Tagung Instandhaltung 2015IFC Ebert Tagung Instandhaltung 2015
IFC Ebert Tagung Instandhaltung 2015
 
IFC Ebert Tagung Instandhaltung 2015
IFC Ebert Tagung Instandhaltung 2015IFC Ebert Tagung Instandhaltung 2015
IFC Ebert Tagung Instandhaltung 2015
 
Seminar: Konstruktion und Dimensionierung mit Faserverbundwerkstoffen im Masc...
Seminar: Konstruktion und Dimensionierung mit Faserverbundwerkstoffen im Masc...Seminar: Konstruktion und Dimensionierung mit Faserverbundwerkstoffen im Masc...
Seminar: Konstruktion und Dimensionierung mit Faserverbundwerkstoffen im Masc...
 
Systementwurf mit UML
Systementwurf mit UMLSystementwurf mit UML
Systementwurf mit UML
 
Von der Lähmschicht zur Schwungmasse
Von der Lähmschicht zur SchwungmasseVon der Lähmschicht zur Schwungmasse
Von der Lähmschicht zur Schwungmasse
 
14. TANNER-Hochschulwettbewerb | Beitrag Team Yu (Hochschule Merseburg)
 14. TANNER-Hochschulwettbewerb | Beitrag Team Yu (Hochschule Merseburg) 14. TANNER-Hochschulwettbewerb | Beitrag Team Yu (Hochschule Merseburg)
14. TANNER-Hochschulwettbewerb | Beitrag Team Yu (Hochschule Merseburg)
 
WIFI-Lehrgang Instandhaltungstechnologien mit Zukunft
WIFI-Lehrgang Instandhaltungstechnologien mit ZukunftWIFI-Lehrgang Instandhaltungstechnologien mit Zukunft
WIFI-Lehrgang Instandhaltungstechnologien mit Zukunft
 
PDM Open Hours - Aufbau, Verwendung und Pflege von Bennennungskatalogen
PDM Open Hours - Aufbau, Verwendung und Pflege von BennennungskatalogenPDM Open Hours - Aufbau, Verwendung und Pflege von Bennennungskatalogen
PDM Open Hours - Aufbau, Verwendung und Pflege von Bennennungskatalogen
 
Dokumentation in der Realität des Anlagenbaus - Hansruedi Steinhauer
Dokumentation in der Realität des Anlagenbaus - Hansruedi SteinhauerDokumentation in der Realität des Anlagenbaus - Hansruedi Steinhauer
Dokumentation in der Realität des Anlagenbaus - Hansruedi Steinhauer
 
Professionelle Anforderungsanalyse am Beispiel einer Java-Anwendung zur Betri...
Professionelle Anforderungsanalyse am Beispiel einer Java-Anwendung zur Betri...Professionelle Anforderungsanalyse am Beispiel einer Java-Anwendung zur Betri...
Professionelle Anforderungsanalyse am Beispiel einer Java-Anwendung zur Betri...
 
12. TANNER-Hochschulwettbewerb | Beitrag Team Schildberg (Karlsruher Institut...
12. TANNER-Hochschulwettbewerb | Beitrag Team Schildberg (Karlsruher Institut...12. TANNER-Hochschulwettbewerb | Beitrag Team Schildberg (Karlsruher Institut...
12. TANNER-Hochschulwettbewerb | Beitrag Team Schildberg (Karlsruher Institut...
 
MC4 Multi Contact Solar Connector
MC4 Multi Contact Solar ConnectorMC4 Multi Contact Solar Connector
MC4 Multi Contact Solar Connector
 
Laser symposium 2018. dresden alemania.- programa general
Laser symposium 2018.  dresden alemania.- programa generalLaser symposium 2018.  dresden alemania.- programa general
Laser symposium 2018. dresden alemania.- programa general
 
Waelzholz 201510-de
Waelzholz 201510-deWaelzholz 201510-de
Waelzholz 201510-de
 
Empfehlung zu Gefahrstoffen 409: „Nutzung von REACH-Informationen für den Arb...
Empfehlung zu Gefahrstoffen 409: „Nutzung von REACH-Informationen für den Arb...Empfehlung zu Gefahrstoffen 409: „Nutzung von REACH-Informationen für den Arb...
Empfehlung zu Gefahrstoffen 409: „Nutzung von REACH-Informationen für den Arb...
 

SW-Benutzerhandbuch und Onlinehilfe aus einer Quelle

  • 1. SW-Benutzerhandbücher und Onlinehilfe – Single source? Tekom RG Bodenseeraum, 14.05.2013 Blatt Nr. 1 Dr. Rainer Pflaum, SysKon Wer sind wir?Wer sind wir? Ein bunt gemischtes Team ausEin bunt gemischtes Team aus NaturwissenschaftlernNaturwissenschaftlern InformatikernInformatikern IngenieurenIngenieuren ProjektleiternProjektleitern Technischen RedakteurenTechnischen Redakteuren StudentenStudenten
  • 2. SW-Benutzerhandbücher und Onlinehilfe – Single source? Tekom RG Bodenseeraum, 14.05.2013 Blatt Nr. 2 Dr. Rainer Pflaum, SysKon Wo arbeiten und leben wir?Wo arbeiten und leben wir?
  • 3. SW-Benutzerhandbücher und Onlinehilfe – Single source? Tekom RG Bodenseeraum, 14.05.2013 Blatt Nr. 3 Dr. Rainer Pflaum, SysKon PrPrääziser:ziser: Wir arbeiten oft bei Siemens (I Mo ILWir arbeiten oft bei Siemens (I Mo IL -- Postautomation)Postautomation)
  • 4. SW-Benutzerhandbücher und Onlinehilfe – Single source? Tekom RG Bodenseeraum, 14.05.2013 Blatt Nr. 4 Dr. Rainer Pflaum, SysKon ... oder in unseren R... oder in unseren Rääumenumen ... oder bei anderen Kunden... oder bei anderen Kunden ... wie ND... wie ND SatComSatCom (Immenstaad)(Immenstaad)
  • 5. SW-Benutzerhandbücher und Onlinehilfe – Single source? Tekom RG Bodenseeraum, 14.05.2013 Blatt Nr. 5 Dr. Rainer Pflaum, SysKon Was tun wir?Was tun wir? Wir unterstWir unterstüützen unsere Kunden beitzen unsere Kunden bei Technischer RedaktionTechnischer Redaktion ProjektleitungProjektleitung ProzessdesignProzessdesign Programmieren von Tools, Makros, ...Programmieren von Tools, Makros, ... Anpassungen des RedaktionssystemsAnpassungen des Redaktionssystems Sonstigen technischen Fragen rund umsSonstigen technischen Fragen rund ums InformationsmanagementInformationsmanagement
  • 6. SW-Benutzerhandbücher und Onlinehilfe – Single source? Tekom RG Bodenseeraum, 14.05.2013 Blatt Nr. 6 Dr. Rainer Pflaum, SysKon Beispiele Redaktion PostautomationBeispiele Redaktion Postautomation FlatsFlats SortingSorting System (FSS, 2000System (FSS, 2000--),), Open Mail Sorter (OMS, 2005Open Mail Sorter (OMS, 2005--)) Modularisierung des GesamtsystemsModularisierung des Gesamtsystems Wartungskonzept erstellenWartungskonzept erstellen OEMOEM--Dokumentation integrierenDokumentation integrieren Sicherheitskonzept integrierenSicherheitskonzept integrieren Diverse Module und Anlagen (1990Diverse Module und Anlagen (1990--)) InstandhaltungsdokumentationInstandhaltungsdokumentation SoftwareSoftware--BenutzerhandbBenutzerhandbüüchercher InstallationsdokumentationInstallationsdokumentation BedienungsanleitungenBedienungsanleitungen
  • 7. SW-Benutzerhandbücher und Onlinehilfe – Single source? Tekom RG Bodenseeraum, 14.05.2013 Blatt Nr. 7 Dr. Rainer Pflaum, SysKon Gliederung des heutigen VortragsGliederung des heutigen Vortrags AnforderungenAnforderungen DIN EN 62079DIN EN 62079 SWSW--BenutzerhandbBenutzerhandbüüchercher OnlinehilfeOnlinehilfe Unterschiede und GemeinsamkeitenUnterschiede und Gemeinsamkeiten SingleSingle sourcesource ffüürr PrintPrint und Onlineund Online Trennung von Inhalt und Seitenlayout,Trennung von Inhalt und Seitenlayout, RedaktionssystemRedaktionssystem Medienneutrale RedaktionMedienneutrale Redaktion AusgewAusgewäählte Beispiele mit Schema ST4hlte Beispiele mit Schema ST4 AusgewAusgewäählte Beispiele mit TIMhlte Beispiele mit TIM--RSRS
  • 8. SW-Benutzerhandbücher und Onlinehilfe – Single source? Tekom RG Bodenseeraum, 14.05.2013 Blatt Nr. 8 Dr. Rainer Pflaum, SysKon DIN EN 62079DIN EN 62079 (aktueller g(aktueller güültiger Stand: 11/2001)ltiger Stand: 11/2001) Erstellen von Anleitungen: Gliederung, Inhalt und DarstellungErstellen von Anleitungen: Gliederung, Inhalt und Darstellung Funktionen der NormFunktionen der Norm detailliert die Anforderungen der EUdetailliert die Anforderungen der EU--Maschinenrichtlinie 98/37/EU undMaschinenrichtlinie 98/37/EU und weitet gleichzeitig den Stand der Technik des Anlagenweitet gleichzeitig den Stand der Technik des Anlagen-- undund Maschinenbaus auf alle Produkte und Dienstleistungen ausMaschinenbaus auf alle Produkte und Dienstleistungen aus setzt qualitative und quantitative Mindeststandards fsetzt qualitative und quantitative Mindeststandards füür technischer technische Informationsmedien (auch elektronische)Informationsmedien (auch elektronische) ChecklistenChecklisten (Zentraler Punkt: Vollst(Zentraler Punkt: Vollstäändigkeit)ndigkeit) Technische Richtigkeit (Anhang B)Technische Richtigkeit (Anhang B) DarstellungsDarstellungsüüberprberprüüfung (Anhang C)fung (Anhang C) BeispielBeispiel--Inhaltsverzeichnis (Anhang D)Inhaltsverzeichnis (Anhang D) sind kostenlos im Internet herunterladbar und frei verwendbarsind kostenlos im Internet herunterladbar und frei verwendbar ersetzen nicht den gut ausgebildeten und fachlich versiertenersetzen nicht den gut ausgebildeten und fachlich versierten Technischen RedakteurTechnischen Redakteur Nationale FuNationale Fußßnote:note: Diese Checkliste darf zur technischenDiese Checkliste darf zur technischen ÜÜberprberprüüfung von Anleitungenfung von Anleitungen gebgebüührenfrei vervielfhrenfrei vervielfäältigt werden bzw. kann kostenfrei heruntergeladenltigt werden bzw. kann kostenfrei heruntergeladen werden von:werden von: http://www.dke.de/de/facharbeit/mitteilungen/62079check.htmhttp://www.dke.de/de/facharbeit/mitteilungen/62079check.htm
  • 9. SW-Benutzerhandbücher und Onlinehilfe – Single source? Tekom RG Bodenseeraum, 14.05.2013 Blatt Nr. 9 Dr. Rainer Pflaum, SysKon DIN EN 62079DIN EN 62079 –– GrundsGrundsäätze (Abs. 4)tze (Abs. 4) 4.1 Anleitung ist Teil des Produkts4.1 Anleitung ist Teil des Produkts Anleitungen sind ein integraler Bestandteil derAnleitungen sind ein integraler Bestandteil der Produktlieferung. Sie mProduktlieferung. Sie müüssen den korrekten Gebrauch einesssen den korrekten Gebrauch eines Produkts erlauben und fProdukts erlauben und föördern.rdern. Der Informationsgehalt der Anleitung muss alle erwartetenDer Informationsgehalt der Anleitung muss alle erwarteten Pflichten des Benutzers abdecken. Daher hPflichten des Benutzers abdecken. Daher häängt der Inhaltngt der Inhalt von der Art der Lieferung ab. Falls z. B. die Errichtung undvon der Art der Lieferung ab. Falls z. B. die Errichtung und Inbetriebnahme Bestandteil der Lieferung sind, erhInbetriebnahme Bestandteil der Lieferung sind, erhäält derlt der Benutzer in den Anleitungen lediglich InformationenBenutzer in den Anleitungen lediglich Informationen üüberber den Betrieb und die Instandhaltung.den Betrieb und die Instandhaltung.
  • 10. SW-Benutzerhandbücher und Onlinehilfe – Single source? Tekom RG Bodenseeraum, 14.05.2013 Blatt Nr. 10 Dr. Rainer Pflaum, SysKon Anforderungen an SWAnforderungen an SW--BenutzerhandbBenutzerhandbüüchercher DarstellungsDarstellungsüüberprberprüüfung nach DIN EN 62079fung nach DIN EN 62079 (Kap. 6, eine Auswahl)(Kap. 6, eine Auswahl) Erst lesen, dann handelnErst lesen, dann handeln Wahrscheinliche Reihenfolge der Ereignisse beim Gebrauch des ProWahrscheinliche Reihenfolge der Ereignisse beim Gebrauch des Produktsdukts definiert Reihenfolge des Textes.definiert Reihenfolge des Textes. Stetig verbessertes VerstehenStetig verbessertes Verstehen Wenn fWenn füür einen sicheren und korrekten Gebrauch des Produktsr einen sicheren und korrekten Gebrauch des Produkts sequentiellen Ablsequentiellen Ablääufen gefolgt werden muss, mufen gefolgt werden muss, müüssen die Anleitungen denssen die Anleitungen den Benutzer befBenutzer befäähigen und ermutigen, einem stetigen Lernhigen und ermutigen, einem stetigen Lern-- undund Verstehensprozess zu folgen (Hilfreich: Abbildungen, Tabellen,Verstehensprozess zu folgen (Hilfreich: Abbildungen, Tabellen, Diagramme).Diagramme). Einfach und kurzEinfach und kurz so einfach und kurz wie möglich, in konsistenten Fachbegriffen und Einheiten formuliert, mit einer klaren Erklärung unüblicher technischer Fachbegriffe. Benutzerfragen vorwegnehmenBenutzerfragen vorwegnehmen Anleitungen mAnleitungen müüssen die Benutzerfragen Wo? Wer? Was? Wann? Wie?ssen die Benutzerfragen Wo? Wer? Was? Wann? Wie? Warum? vorwegnehmen und Antworten darauf liefern.Warum? vorwegnehmen und Antworten darauf liefern. Ein Satz, eine HandlungsanweisungEin Satz, eine Handlungsanweisung Ein Satz darf nur eine Handlungsanweisung enthalten oder hEin Satz darf nur eine Handlungsanweisung enthalten oder hööchstens einechstens eine kleine Anzahl eng verbundener Handlungsanweisungen.kleine Anzahl eng verbundener Handlungsanweisungen. ...... uvmuvm..
  • 11. SW-Benutzerhandbücher und Onlinehilfe – Single source? Tekom RG Bodenseeraum, 14.05.2013 Blatt Nr. 11 Dr. Rainer Pflaum, SysKon Anforderungen an SWAnforderungen an SW--BenutzerhandbBenutzerhandbüüchercher DarstellungsDarstellungsüüberprberprüüfung nach DIN EN 62079fung nach DIN EN 62079 (Kap. 6, auszugsweise)(Kap. 6, auszugsweise) Leserlichkeit / Schriftart und GrLeserlichkeit / Schriftart und Größößee ... gr... größößtmtmöögliche Leserlichkeit sicherstellen,gliche Leserlichkeit sicherstellen, ... Flie... Fließßtext nicht kleiner als 9text nicht kleiner als 9 PicaPica Punkte.Punkte. AbbildungenAbbildungen auf Qualitauf Qualitäät und Klarheit achten, medienunabht und Klarheit achten, medienunabhäängigngig ... Text und Abbildung zusammen anwenden... Text und Abbildung zusammen anwenden ... eine Abbildung = eine Informationseinheit... eine Abbildung = eine Informationseinheit Grafische SymboleGrafische Symbole ...... müssen anerkannten Normen folgen ...... müssen in den Anleitungen erklärt sein ... TabellenTabellen ... wo diese das Verst... wo diese das Verstäändnis fndnis föördernrdern ... angrenzend an den zugeh... angrenzend an den zugehöörigen Textrigen Text ... Wiederholen wo n... Wiederholen wo nöötig.tig. WarnhinweiseWarnhinweise ... Hervorheben,... Hervorheben, zum richtigen Zeitpunkt sichtbarzum richtigen Zeitpunkt sichtbar ... gib klare Anweisungen, was zu tun ist... gib klare Anweisungen, was zu tun ist ... gib klare Anweisungen, was zu vermeiden ist. ...... gib klare Anweisungen, was zu vermeiden ist. ... ...... uvmuvm..
  • 12. SW-Benutzerhandbücher und Onlinehilfe – Single source? Tekom RG Bodenseeraum, 14.05.2013 Blatt Nr. 12 Dr. Rainer Pflaum, SysKon In welchen Situationen wird die Hilfe geIn welchen Situationen wird die Hilfe geööffnet?ffnet? Start einer AufgabeStart einer Aufgabe Fehlen erwarteter FunktionenFehlen erwarteter Funktionen Ganz allgemeinGanz allgemein …… Online und HilfeOnline und Hilfe
  • 13. SW-Benutzerhandbücher und Onlinehilfe – Single source? Tekom RG Bodenseeraum, 14.05.2013 Blatt Nr. 13 Dr. Rainer Pflaum, SysKon Anforderungen OnlinehilfeAnforderungen Onlinehilfe Der Nutzer sucht beim Aufruf der OnlinehilfeDer Nutzer sucht beim Aufruf der Onlinehilfe Antwort auf die FrageAntwort auf die Frage „„Wie geht es nun weiter?Wie geht es nun weiter?““ Daraus ergeben sich Anforderungen wieDaraus ergeben sich Anforderungen wie Kontextsensitive HilfeKontextsensitive Hilfe Separates HilfefensterSeparates Hilfefenster Kompakte Hilfethemen, Scrollen mKompakte Hilfethemen, Scrollen mööglichst vermeidenglichst vermeiden VerstVerstäändnis der aktuellen Funktionndnis der aktuellen Funktion AnwendungsfAnwendungsfäällelle VerstVerstäändnis der Prozessendnis der Prozesse
  • 14. SW-Benutzerhandbücher und Onlinehilfe – Single source? Tekom RG Bodenseeraum, 14.05.2013 Blatt Nr. 14 Dr. Rainer Pflaum, SysKon Unterschiede, GemeinsamkeitenUnterschiede, Gemeinsamkeiten Was aus dem Handbuch ist onlineWas aus dem Handbuch ist online üüberflberflüüssig?ssig? Anweisungen zum Installieren der SoftwareAnweisungen zum Installieren der Software Was wird online zusWas wird online zusäätzlich bentzlich benöötigt?tigt? Anweisungen zum Bedienen der OnlineAnweisungen zum Bedienen der Online--HilfeHilfe --> SW> SW--InstallationshandbInstallationshandbüüchercher Der Rest wird fDer Rest wird füür beide Medien benr beide Medien benöötigt!tigt! ... sofern er redaktionell optimiert ist... sofern er redaktionell optimiert ist Unterschiede: Seitenlayout, ReferenzenUnterschiede: Seitenlayout, Referenzen
  • 15. SW-Benutzerhandbücher und Onlinehilfe – Single source? Tekom RG Bodenseeraum, 14.05.2013 Blatt Nr. 15 Dr. Rainer Pflaum, SysKon GemeinsamkeitenGemeinsamkeiten –– Redaktion / RechercheRedaktion / Recherche Alle Informationen zusammentragenAlle Informationen zusammentragen SpezifikationenSpezifikationen Software in AktionSoftware in Aktion Entwickler oder andere Experten befragenEntwickler oder andere Experten befragen per Eper E--MailMail telefonischtelefonisch perspersöönliches Gesprnliches Gespräächch Wichtig: Fragen Sie so lange,Wichtig: Fragen Sie so lange, bis Sie esbis Sie es wirklichwirklich verstanden haben.verstanden haben.
  • 16. SW-Benutzerhandbücher und Onlinehilfe – Single source? Tekom RG Bodenseeraum, 14.05.2013 Blatt Nr. 16 Dr. Rainer Pflaum, SysKon GemeinsamkeitenGemeinsamkeiten –– Text erstellenText erstellen Ich habe keine ZeitIch habe keine Zeit Ihnen einen kurzen Brief zu schreiben,Ihnen einen kurzen Brief zu schreiben, deshalb schreibe ich einen langen.deshalb schreibe ich einen langen. Erstellen guter Texte:Erstellen guter Texte: aus vielen korrekten Waus vielen korrekten Wöörtern das genau treffendertern das genau treffende Wort auswWort auswäählenhlen von den syntaktisch korrekten Varianten die einevon den syntaktisch korrekten Varianten die eine nutzen, die den Leser besonders ansprichtnutzen, die den Leser besonders anspricht die Botschaft des Auftraggebersdie Botschaft des Auftraggebers üübermitteln und diebermitteln und die Regeln der CorporateRegeln der Corporate IdentityIdentity (CI) beachten !(CI) beachten !
  • 17. SW-Benutzerhandbücher und Onlinehilfe – Single source? Tekom RG Bodenseeraum, 14.05.2013 Blatt Nr. 17 Dr. Rainer Pflaum, SysKon GemeinsamkeitenGemeinsamkeiten –– Text erstellenText erstellen WertschWertschööpfung durch gute Texte:pfung durch gute Texte: wirkt auf das Imagewirkt auf das Image Image spricht sich herumImage spricht sich herum EntscheidungskritieriumEntscheidungskritierium bei gleicher Qualitbei gleicher Qualitäätt KundenzufriedenheitKundenzufriedenheit weniger Nachfragen und Beschwerdenweniger Nachfragen und Beschwerden weniger Gewweniger Gewäährleistungsansprhrleistungsansprüücheche Also:Also: Professionelles DeutschProfessionelles Deutsch Kontrolliertes DeutschKontrolliertes Deutsch
  • 18. SW-Benutzerhandbücher und Onlinehilfe – Single source? Tekom RG Bodenseeraum, 14.05.2013 Blatt Nr. 18 Dr. Rainer Pflaum, SysKon GemeinsamkeitenGemeinsamkeiten –– Text erstellenText erstellen Zu den Kompetenzen des technischen Redakteurs gehZu den Kompetenzen des technischen Redakteurs gehöört:rt: Informationen verstInformationen verstäändlich aufbereitenndlich aufbereiten VerstVerstäändlichkeit von Texten beurteilenndlichkeit von Texten beurteilen TextschwTextschwäächen erkennen und behebenchen erkennen und beheben Eine leicht verstEine leicht verstäändliche Sprache anzuwendenndliche Sprache anzuwenden bedeutet nicht mangelnde Bildung!bedeutet nicht mangelnde Bildung! Gut, kurz und vollstGut, kurz und vollstäändig zu (ndig zu (bebe--)schreiben)schreiben ist ein Handwerk, das vor allem geist ein Handwerk, das vor allem geüübt sein will.bt sein will.
  • 19. SW-Benutzerhandbücher und Onlinehilfe – Single source? Tekom RG Bodenseeraum, 14.05.2013 Blatt Nr. 19 Dr. Rainer Pflaum, SysKon GemeinsamkeitenGemeinsamkeiten –– Text erstellenText erstellen Es gibt zwei Sorten Menschen:Es gibt zwei Sorten Menschen: die einen schreiben gut unddie einen schreiben gut und trauen sich aber nicht an Technik herantrauen sich aber nicht an Technik heran die anderen verstehen die Technik,die anderen verstehen die Technik, kköönnen es aber nicht verstnnen es aber nicht verstäändlich beschreibenndlich beschreiben „„Papa, wozu gehPapa, wozu gehöören dann die technischen Redakteure?ren dann die technischen Redakteure?““:: dreidrei Fazit:Fazit: DurchDurch SingleSingle sourcesource Zeit gewinnen fZeit gewinnen füürr die Kernaufgaben der Redaktion!die Kernaufgaben der Redaktion!
  • 20. SW-Benutzerhandbücher und Onlinehilfe – Single source? Tekom RG Bodenseeraum, 14.05.2013 Blatt Nr. 20 Dr. Rainer Pflaum, SysKon UnterschiedeUnterschiede –– Grafiken erstellenGrafiken erstellen Grafiken in Anleitungen:Grafiken in Anleitungen: erherhööhen die Versthen die Verstäändlichkeit, wenn siendlichkeit, wenn sie eng beim zugeheng beim zugehöörigen Text stehenrigen Text stehen die wesentlichen Zusammenhdie wesentlichen Zusammenhäänge sofort deutlichnge sofort deutlich erkennen lassenerkennen lassen PrintPrint:: ScreenshotsScreenshots 1:1, Fotos 3001:1, Fotos 300 dpidpi Online: Max. ca. 700 Pixel breit, Exporte 120Online: Max. ca. 700 Pixel breit, Exporte 120 dpidpi,, AntialiasAntialias BspBsp: PNG, 256 Farben, verlustfrei,: PNG, 256 Farben, verlustfrei, 1827x1074, 189KB1827x1074, 189KB
  • 21. SW-Benutzerhandbücher und Onlinehilfe – Single source? Tekom RG Bodenseeraum, 14.05.2013 Blatt Nr. 21 Dr. Rainer Pflaum, SysKon GemeinsamkeitenGemeinsamkeiten –– Grafiken erstellenGrafiken erstellen Grafiken in Anleitungen: DerGrafiken in Anleitungen: Der JPGJPG--EffektEffekt JPG ist ein prima Kompressionsalgorithmus fJPG ist ein prima Kompressionsalgorithmus füürr Fotos, aber erzeugt zwangsweiseFotos, aber erzeugt zwangsweise schmutzigeschmutzige Wolken bei allen vollfarbigen ObjektenWolken bei allen vollfarbigen Objekten wiewie ScreenshotsScreenshots (au(außßer sie zeigen Fotos/Videos)er sie zeigen Fotos/Videos) Nummern in FotosNummern in Fotos ZeichnungenZeichnungen
  • 22. SW-Benutzerhandbücher und Onlinehilfe – Single source? Tekom RG Bodenseeraum, 14.05.2013 Blatt Nr. 22 Dr. Rainer Pflaum, SysKon GemeinsamkeitenGemeinsamkeiten –– SicherheitshinweiseSicherheitshinweise ANSI Z 535.6ANSI Z 535.6 (U.S.(U.S.--Standard)Standard) -- eben noch exotisch, jetzt auch bei dereben noch exotisch, jetzt auch bei der TekomTekom :: Keine separate Auszeichnung vonKeine separate Auszeichnung von MaschinenschMaschinenschääden, Datenverlust etcden, Datenverlust etc mehr!mehr!
  • 23. SW-Benutzerhandbücher und Onlinehilfe – Single source? Tekom RG Bodenseeraum, 14.05.2013 Blatt Nr. 23 Dr. Rainer Pflaum, SysKon GemeinsamkeitenGemeinsamkeiten –– SicherheitshinweiseSicherheitshinweise Wie kann man auf das gute alteWie kann man auf das gute alte „„AchtungAchtung““ verzichten?verzichten? Gefahr der Zerstörung der Anlage Gefahr des Daten- verlusts Missachtung von Hinweisen kostet unnötige Techniker-Zeit All dies sind mögliche pekuniäre Schäden, also Unwichtige Informationen gibt es nicht in unserer Anleitung!
  • 24. SW-Benutzerhandbücher und Onlinehilfe – Single source? Tekom RG Bodenseeraum, 14.05.2013 Blatt Nr. 24 Dr. Rainer Pflaum, SysKon RedaktionssystemRedaktionssystem –– Inhalt und LayoutInhalt und Layout mediengerecht trennenmediengerecht trennen Produktionen einer Information/DokumentationProduktionen einer Information/Dokumentation EinsparpotenzialEinsparpotenzial nutzen!nutzen! Variante A B C Sprache EnglischDeutschSpanisch Format Print Help Internet ©SCHEMAGmbH
  • 25. SW-Benutzerhandbücher und Onlinehilfe – Single source? Tekom RG Bodenseeraum, 14.05.2013 Blatt Nr. 25 Dr. Rainer Pflaum, SysKon UnterschiedeUnterschiede –– SeitenlayoutSeitenlayout Thema:Thema: PrintPrint:: Online:Online:
  • 26. SW-Benutzerhandbücher und Onlinehilfe – Single source? Tekom RG Bodenseeraum, 14.05.2013 Blatt Nr. 26 Dr. Rainer Pflaum, SysKon UnterschiedeUnterschiede –– QuerverweiseQuerverweise Konfiguration:Konfiguration: PrintPrint:: Online:Online:
  • 27. SW-Benutzerhandbücher und Onlinehilfe – Single source? Tekom RG Bodenseeraum, 14.05.2013 Blatt Nr. 27 Dr. Rainer Pflaum, SysKon OnlinehilfeOnlinehilfe –– kontextsensitiv, Bsp. ST4kontextsensitiv, Bsp. ST4 Konfiguration:Konfiguration: Dateien:Dateien: Einsprung:Einsprung:
  • 28. SW-Benutzerhandbücher und Onlinehilfe – Single source? Tekom RG Bodenseeraum, 14.05.2013 Blatt Nr. 28 Dr. Rainer Pflaum, SysKon OnlinehilfeOnlinehilfe –– kontextsensitiv, Bsp. TIMkontextsensitiv, Bsp. TIM--RSRS EinsprungEinsprung KonfigurationKonfiguration
  • 29. SW-Benutzerhandbücher und Onlinehilfe – Single source? Tekom RG Bodenseeraum, 14.05.2013 Blatt Nr. 29 Dr. Rainer Pflaum, SysKon OnlinehilfeOnlinehilfe –– kontextsensitiv, Bsp. PDFkontextsensitiv, Bsp. PDF Anleitung zur Konfiguration bei Adobe:Anleitung zur Konfiguration bei Adobe: www.adobe.com/devnet/acrobat/pdfs/www.adobe.com/devnet/acrobat/pdfs/ pdf_open_parameters.pdfpdf_open_parameters.pdf Beispielaufruf mit Seite 7:Beispielaufruf mit Seite 7: AcroRD32.exe /A "page=7"AcroRD32.exe /A "page=7" c:c:temptemptest.pdftest.pdf
  • 30. SW-Benutzerhandbücher und Onlinehilfe – Single source? Tekom RG Bodenseeraum, 14.05.2013 Blatt Nr. 30 Dr. Rainer Pflaum, SysKon Vielen DankVielen Dank ffüür Ihre Aufmerksamkeit!r Ihre Aufmerksamkeit!