SW-Benutzerhandbuch und Onlinehilfe aus einer Quelle

SW-Benutzerhandbücher und Onlinehilfe – Single source?Tekom RG Bodenseeraum, 14.05.2013

Blatt Nr. 1Dr. Rainer Pflaum, SysKon

Wer sind wir?Wer sind wir?

Ein bunt gemischtes Team ausEin bunt gemischtes Team aus

NaturwissenschaftlernNaturwissenschaftlernInformatikernInformatikernIngenieurenIngenieurenProjektleiternProjektleiternTechnischen RedakteurenTechnischen RedakteurenStudentenStudenten



Wo arbeiten und leben wir?Wo arbeiten und leben wir?



PrPrääziser:ziser:

Wir arbeiten oft bei Siemens (I Mo IL Wir arbeiten oft bei Siemens (I Mo IL -- Postautomation)Postautomation)



... oder in unseren R... oder in unseren Rääumenumen

... oder bei anderen Kunden... oder bei anderen Kunden

... wie ND ... wie ND SatComSatCom (Immenstaad)(Immenstaad)



Was tun wir?Was tun wir?

Wir unterstWir unterstüützen unsere Kunden beitzen unsere Kunden beiTechnischer RedaktionTechnischer RedaktionProjektleitungProjektleitungProzessdesignProzessdesignProgrammieren von Tools, Makros, ...Programmieren von Tools, Makros, ...Anpassungen des RedaktionssystemsAnpassungen des RedaktionssystemsSonstigen technischen Fragen rund ums Sonstigen technischen Fragen rund ums InformationsmanagementInformationsmanagement



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 GesamtsystemsWartungskonzept erstellenWartungskonzept erstellenOEMOEM--Dokumentation integrierenDokumentation integrierenSicherheitskonzept integrierenSicherheitskonzept integrieren

Diverse Module und Anlagen (1990Diverse Module und Anlagen (1990--))InstandhaltungsdokumentationInstandhaltungsdokumentationSoftwareSoftware--BenutzerhandbBenutzerhandbüüchercherInstallationsdokumentationInstallationsdokumentationBedienungsanleitungenBedienungsanleitungen



Gliederung des heutigen VortragsGliederung des heutigen Vortrags

AnforderungenAnforderungenDIN EN 62079DIN EN 62079SWSW--BenutzerhandbBenutzerhandbüüchercherOnlinehilfeOnlinehilfeUnterschiede und GemeinsamkeitenUnterschiede und Gemeinsamkeiten

Single Single sourcesource ffüür r PrintPrint und Onlineund OnlineTrennung von Inhalt und Seitenlayout, Trennung von Inhalt und Seitenlayout, RedaktionssystemRedaktionssystemMedienneutrale RedaktionMedienneutrale RedaktionAusgewAusgewäählte Beispiele mit Schema ST4hlte Beispiele mit Schema ST4AusgewAusgewäählte Beispiele mit TIMhlte Beispiele mit TIM--RSRS



DIN EN 62079 DIN 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 DarstellungFunktionen der NormFunktionen der Norm

detailliert die Anforderungen der EUdetailliert die Anforderungen der EU--Maschinenrichtlinie 98/37/EU und Maschinenrichtlinie 98/37/EU und weitet gleichzeitig den Stand der Technik des Anlagenweitet gleichzeitig den Stand der Technik des Anlagen-- und und Maschinenbaus auf alle Produkte und Dienstleistungen ausMaschinenbaus auf alle Produkte und Dienstleistungen aussetzt qualitative und quantitative Mindeststandards fsetzt qualitative und quantitative Mindeststandards füür technische r technische Informationsmedien (auch elektronische)Informationsmedien (auch elektronische)

Checklisten Checklisten (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 verwendbarersetzen nicht den gut ausgebildeten und fachlich versierten ersetzen nicht den gut ausgebildeten und fachlich versierten Technischen RedakteurTechnischen Redakteur

Nationale FuNationale Fußßnote: note: Diese Checkliste darf zur technischen Diese Checkliste darf zur technischen ÜÜberprberprüüfung von Anleitungen fung von Anleitungen gebgebüührenfrei vervielfhrenfrei vervielfäältigt werden bzw. kann kostenfrei heruntergeladen ltigt 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



DIN EN 62079 DIN 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 der Anleitungen sind ein integraler Bestandteil der Produktlieferung. Sie mProduktlieferung. Sie müüssen den korrekten Gebrauch eines ssen den korrekten Gebrauch eines Produkts erlauben und fProdukts erlauben und föördern.rdern.Der Informationsgehalt der Anleitung muss alle erwarteten Der Informationsgehalt der Anleitung muss alle erwarteten Pflichten des Benutzers abdecken. Daher hPflichten des Benutzers abdecken. Daher häängt der Inhalt ngt der Inhalt von der Art der Lieferung ab. Falls z. B. die Errichtung und von der Art der Lieferung ab. Falls z. B. die Errichtung und Inbetriebnahme Bestandteil der Lieferung sind, erhInbetriebnahme Bestandteil der Lieferung sind, erhäält der lt der Benutzer in den Anleitungen lediglich Informationen Benutzer in den Anleitungen lediglich Informationen üüber ber den Betrieb und die Instandhaltung.den Betrieb und die Instandhaltung.



Anforderungen an SWAnforderungen an SW--BenutzerhandbBenutzerhandbüüchercher

DarstellungsDarstellungsüüberprberprüüfung nach DIN EN 62079 fung nach DIN EN 62079 (Kap. 6, eine Auswahl)(Kap. 6, eine Auswahl)

Erst lesen, dann handelnErst lesen, dann handelnWahrscheinliche Reihenfolge der Ereignisse beim Gebrauch des ProWahrscheinliche Reihenfolge der Ereignisse beim Gebrauch des Produkts dukts definiert Reihenfolge des Textes.definiert Reihenfolge des Textes.Stetig verbessertes VerstehenStetig verbessertes VerstehenWenn fWenn füür einen sicheren und korrekten Gebrauch des Produkts r einen sicheren und korrekten Gebrauch des Produkts sequentiellen Ablsequentiellen Ablääufen gefolgt werden muss, mufen gefolgt werden muss, müüssen die Anleitungen den ssen die Anleitungen den Benutzer befBenutzer befäähigen und ermutigen, einem stetigen Lernhigen und ermutigen, einem stetigen Lern-- und und Verstehensprozess zu folgen (Hilfreich: Abbildungen, Tabellen, Verstehensprozess zu folgen (Hilfreich: Abbildungen, Tabellen, Diagramme).Diagramme).Einfach und kurzEinfach und kurzso einfach und kurz wie möglich, in konsistenten Fachbegriffen und Einheiten formuliert, mit einer klaren Erklärung unüblicher technischer Fachbegriffe.Benutzerfragen vorwegnehmenBenutzerfragen vorwegnehmenAnleitungen 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 HandlungsanweisungEin Satz darf nur eine Handlungsanweisung enthalten oder hEin Satz darf nur eine Handlungsanweisung enthalten oder hööchstens eine chstens eine kleine Anzahl eng verbundener Handlungsanweisungen.kleine Anzahl eng verbundener Handlungsanweisungen.... ... uvmuvm..



Anforderungen an SWAnforderungen an SW--BenutzerhandbBenutzerhandbüüchercher

DarstellungsDarstellungsüüberprberprüüfung nach DIN EN 62079 fung 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 9 text nicht kleiner als 9 PicaPica Punkte.Punkte.AbbildungenAbbildungenauf 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 InformationseinheitGrafische 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..



In welchen Situationen wird die Hilfe geIn welchen Situationen wird die Hilfe geööffnet?ffnet?Start einer AufgabeStart einer AufgabeFehlen erwarteter FunktionenFehlen erwarteter FunktionenGanz allgemein Ganz allgemein ……

Online und HilfeOnline und Hilfe



Anforderungen OnlinehilfeAnforderungen Onlinehilfe

Der Nutzer sucht beim Aufruf der Onlinehilfe Der Nutzer sucht beim Aufruf der Onlinehilfe Antwort auf die Frage Antwort auf die Frage „„Wie geht es nun weiter?Wie geht es nun weiter?““Daraus ergeben sich Anforderungen wieDaraus ergeben sich Anforderungen wie

Kontextsensitive HilfeKontextsensitive HilfeSeparates Hilfefenster Separates Hilfefenster Kompakte Hilfethemen, Scrollen mKompakte Hilfethemen, Scrollen mööglichst vermeidenglichst vermeidenVerstVerstäändnis der aktuellen Funktionndnis der aktuellen FunktionAnwendungsfAnwendungsfäällelleVerstVerstäändnis der Prozessendnis der Prozesse



Unterschiede, GemeinsamkeitenUnterschiede, Gemeinsamkeiten

Was aus dem Handbuch ist online Was 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 istUnterschiede: Seitenlayout, ReferenzenUnterschiede: Seitenlayout, Referenzen



GemeinsamkeitenGemeinsamkeiten –– Redaktion / RechercheRedaktion / Recherche

Alle Informationen zusammentragenAlle Informationen zusammentragenSpezifikationenSpezifikationenSoftware in AktionSoftware in Aktion

Entwickler oder andere Experten befragen Entwickler oder andere Experten befragen per Eper E--Mail Mail telefonischtelefonischperspersöönliches Gesprnliches Gespräächch

Wichtig: Fragen Sie so lange,Wichtig: Fragen Sie so lange,bis Sie es bis Sie es wirklichwirklich verstanden haben. verstanden haben.



GemeinsamkeitenGemeinsamkeiten –– Text erstellenText erstellen

Ich habe keine ZeitIch habe keine ZeitIhnen 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 treffende rtern das genau treffende Wort auswWort auswäählenhlenvon den syntaktisch korrekten Varianten die eine von den syntaktisch korrekten Varianten die eine nutzen, die den Leser besonders ansprichtnutzen, die den Leser besonders ansprichtdie Botschaft des Auftraggebers die Botschaft des Auftraggebers üübermitteln und die bermitteln und die Regeln der Corporate Regeln der Corporate IdentityIdentity (CI) beachten !(CI) beachten !




WertschWertschööpfung durch gute Texte:pfung durch gute Texte:wirkt auf das Imagewirkt auf das ImageImage spricht sich herumImage spricht sich herumEntscheidungskritieriumEntscheidungskritierium bei gleicher Qualitbei gleicher QualitäättKundenzufriedenheitKundenzufriedenheitweniger Nachfragen und Beschwerdenweniger Nachfragen und Beschwerdenweniger Gewweniger Gewäährleistungsansprhrleistungsansprüücheche

Also:Also:Professionelles DeutschProfessionelles DeutschKontrolliertes DeutschKontrolliertes Deutsch




Zu den Kompetenzen des technischen Redakteurs gehZu den Kompetenzen des technischen Redakteurs gehöört:rt:Informationen verstInformationen verstäändlich aufbereitenndlich aufbereitenVerstVerstäändlichkeit von Texten beurteilenndlichkeit von Texten beurteilenTextschwTextschwäächen erkennen und behebenchen erkennen und beheben

Eine leicht verstEine leicht verstäändliche Sprache anzuwenden ndliche Sprache anzuwenden bedeutet nicht mangelnde Bildung! bedeutet nicht mangelnde Bildung! Gut, kurz und vollstGut, kurz und vollstäändig zu (ndig zu (bebe--)schreiben)schreibenist ein Handwerk, das vor allem geist ein Handwerk, das vor allem geüübt sein will.bt sein will.




Es gibt zwei Sorten Menschen:Es gibt zwei Sorten Menschen:die einen schreiben gut und die einen schreiben gut und trauen sich aber nicht an Technik herantrauen sich aber nicht an Technik herandie 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:Durch Durch Single Single sourcesource Zeit gewinnen fZeit gewinnen füür r

die Kernaufgaben der Redaktion!die Kernaufgaben der Redaktion!



UnterschiedeUnterschiede –– Grafiken erstellenGrafiken erstellen

Grafiken in Anleitungen:Grafiken in Anleitungen:erherhööhen die Versthen die Verstäändlichkeit, wenn sie ndlichkeit, wenn sie

eng beim zugeheng beim zugehöörigen Text stehenrigen Text stehendie wesentlichen Zusammenhdie wesentlichen Zusammenhäänge sofort deutlich nge sofort deutlich erkennen lassenerkennen lassen

PrintPrint: : ScreenshotsScreenshots 1:1, Fotos 300 1:1, Fotos 300 dpidpi

Online: Max. ca. 700 Pixel breit, Exporte 120 Online: Max. ca. 700 Pixel breit, Exporte 120 dpidpi, , AntialiasAntialias

BspBsp: PNG, 256 Farben, verlustfrei, : PNG, 256 Farben, verlustfrei, 1827x1074, 189KB1827x1074, 189KB



GemeinsamkeitenGemeinsamkeiten –– Grafiken erstellenGrafiken erstellen

Grafiken in Anleitungen: Der Grafiken in Anleitungen: Der JPGJPG--EffektEffektJPG ist ein prima Kompressionsalgorithmus fJPG ist ein prima Kompressionsalgorithmus füür r Fotos, aber erzeugt zwangsweise Fotos, aber erzeugt zwangsweise schmutzige schmutzige 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 FotosZeichnungenZeichnungen



Gemeinsamkeiten Gemeinsamkeiten –– SicherheitshinweiseSicherheitshinweise

ANSI Z 535.6 ANSI Z 535.6 (U.S.(U.S.--Standard)Standard) -- eben noch exotisch, jetzt auch bei der eben noch exotisch, jetzt auch bei der TekomTekom ::

Keine separate Auszeichnung von Keine separate Auszeichnung von MaschinenschMaschinenschääden, Datenverlust etc den, Datenverlust etc mehr!mehr!



Gemeinsamkeiten Gemeinsamkeiten –– SicherheitshinweiseSicherheitshinweise

Wie kann man auf das gute alte Wie kann man auf das gute alte „„AchtungAchtung““ verzichten?verzichten?

Gefahr derZerstörung der

AnlageGefahr des

Daten-verlusts

Missachtung von Hinweisen kostet unnötige

Techniker-Zeit

All dies sind möglichepekuniäre Schäden, also

Unwichtige Informationen gibtes nicht in unserer Anleitung!



Redaktionssystem Redaktionssystem –– Inhalt und Layout Inhalt und Layout mediengerecht trennenmediengerecht trennen

Produktionen einer Information/DokumentationProduktionen einer Information/Dokumentation

Einsparpotenzial Einsparpotenzial nutzen!nutzen!

Varian

te

A

B

C

Sprache

Englisch

Deutsch

Spanisch

FormatPrint Help Internet

©S

CH

EM

A G

mbH



UnterschiedeUnterschiede –– SeitenlayoutSeitenlayout

Thema:Thema:

PrintPrint::

Online:Online:



UnterschiedeUnterschiede –– QuerverweiseQuerverweise

Konfiguration:Konfiguration:

PrintPrint::

Online:Online:



OnlinehilfeOnlinehilfe –– kontextsensitiv, Bsp. ST4kontextsensitiv, Bsp. ST4

Konfiguration:Konfiguration:

Dateien:Dateien:

Einsprung:Einsprung:



OnlinehilfeOnlinehilfe –– kontextsensitiv, Bsp. TIMkontextsensitiv, Bsp. TIM--RSRS

EinsprungEinsprung

KonfigurationKonfiguration



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:\\temptemp\\test.pdftest.pdf

http://www.adobe.com/devnet/acrobat/pdfs/pdf_open_parameters.pdf

http://www.adobe.com/devnet/acrobat/pdfs/pdf_open_parameters.pdf



Vielen DankVielen Dankffüür Ihre Aufmerksamkeit!r Ihre Aufmerksamkeit!

SW-Benutzerhandbuch und Onlinehilfe aus einer Quelle

Business

Transcript of SW-Benutzerhandbuch und Onlinehilfe aus einer Quelle