Technische Dokumentation
/Index /Kommandozeile /Keyboard /TDLiteratur /TDDownload /HTMLHelp /WinHelp

Technische Dokumentation / Online-Hilfen

Online Hilfe auf Basis von HTML

Diese Art der Hilfe wird spätestens seit Windows®98 von Microsoft neben der bisherigen reinen Windows-Hilfe unterstützt. Natürlich haben sich die Hersteller so genannter komfortabler Hilfe-Erstellungstools auch daran gemacht, Microsofts HTML Hilfe zu unterstützen und aus anderen Sourcen (z.B. Word-Dokumenten) zu erstellen. Für die Anzeige ist nicht ein normaler Browser, sondern eine speziell angepasste Version des Internet Explorer im Betrieb notwendig und gaukelt dem Benutzer vor, die Hilfe im Browser betrachten zu können. Das Lesewerkzeug HHUpd.exe (aktuelle Version: 1.32) kann für alle älteren 32-Bit Windows-Betriebssysteme (vor Windows 98) auch von der offiziellen Microsoft-Seite geladen werden. Siehe in meiner Download Area.

Seit Juli 2000 befasste ich mich mit HTML Hilfe. Meine Beschreibung, wie man eine derartige Hilfe aufbaut, wird auf der separaten Site HTMLHelp beschrieben und im Rahmen meiner Erfahrungen und eurer Fragen permanent ergänzt.

Erstellung von Windows Hilfe (WinHelp)

Zur Erstellung kompletter Software-Dokumentation gehört neben gedruckten Werken auch eine Online Hilfe. Solche Hilfe-Dokumente haben den Vorteil, an jedem Computer-Arbeitsplatz verfügbar zu sein. Unter Windows lässt sich eine Hilfe-Datei relativ leicht auch mit einfachen Werkzeugen erstellen. Benötigt werden ein (kostenloser) Microsoft Hilfecompiler (HCP für Windows 3.x und HCW für Windows 9x oder NT) sowie ein Editor zum Erstellen der Rohtexte im RTF-Format. Texte lassen sich schnell layouten und mit Abbildungen sowie Hyperlinks gestalten. Der Aufbau der Compiler-Projektdatei wird ebenfalls auf der separaten Site WinHelp erklärt.

Autorensysteme

Obwohl ich kein Freund und Anwender integrierter Entwicklungsumgebungen bin, möchte ich die werte Leserschaft durchaus auf einzelne Tools hinweisen. Aber Achtung! Diese Liste wird niemals auch nur annähernd vollständig sein.

WebHelp

"Mit der WebHelp-Technologie von eHelp Software kann Online-Hilfe für verschiedene Plattformen und Browser zur Verfügung gestellt werden. WebHelp bietet Navigationsmöglichkeiten wie Inhaltsverzeichnis, Index, Suche und seit Version 5.00 die Erstellung eines Glossars. Im Gegensatz zu WinHelp oder HTMLHelp handelt es sich bei WebHelp um ein unkompiliertes Format. Von Autoren entwickelte Online-Hilfe kann somit für Intranet und Internet bereitgestellt werden." Soweit ein Zitat von Stefan Schäffler, der sich unter pixelparrot.de ausgiebig mit diesem Thema befasst.

RoboHelp

Hierunter ist neben einem vollständigen Autorensystem auch ein AddOn zu Microsoft Word zu verstehen, das aus dem Quelltext WinHelp, HTML Help, WebHelp und JavaHelp sowie gedruckte Informationen zum eigenen Hilfesystem erstellen soll. Ich habe dies im I. Quartal 2003 an einem sehr umfangreichen, modularen, dreisprachigen Projekt mit kontextsensitiver Hilfe ausprobiert, indem ich dies von WinHelp nach HTML Help umgewandelt habe. Ganz so einfach war es definitv nicht. Ein Praktikant hat drei Wochen intensive Nacharbeit benötigt, um das Projekt mehr oder weniger komfortabel in eine HTML Hilfe zu transferieren. Mit Hilfe einiger dateiübergreifender Suchen-Ersetzen-Funktionen (z.B. mit Phase 5) konnten letztlich aber alle Schwachpunkte ausgemerzt werden und das Produkt wird seitdem mit HTML Hilfe ausgeliefert.
Alternativ kann RoboHelp auch völlig eigenständig, also ohne Word als Basis, genutzt werden. Die Werbeleute sagen: "Mit RoboHelp Office können Sie in Rekordzeit Hilfesysteme mit vollem Funktionsumfang für Ihre Windows- und webbasierten Anwendungen, einschließlich .NET, erstellen. RoboHelp Office X3 bietet neue Funktionen, die Ihre Produktivität wesentlich erhöhen und für außergewöhnliche Flexibilität in den Bereichen Single-Sourcing, Bedingungstext, Ausgabeformate für gedruckte Dokumentation sowie Zusammenführung und Nutzbarkeit von Hilfesystemen sorgen."

Artikel aus Zeitschrift von Zoschke-Data

Im Oktober erhielt ich ein broschürenartiges Heft namens "DevDorado 3/2002". Darin fand ich einen Artikel über Online Dokumentation, der sich mit Doc-to-Help 6.0, HelpPartner 6.1, RoboDemo 3.0, RoboHelp Office X3 und RoboHelp for Word befasst. Beachtet, dass dieser Beitrag vom Vertreiber Zoschke Data stammt. Siehe Teil 1, 2, 3 bei den folgenden Links.

Links zu Autorensysteme

Über eHelp konnte man Webhelp testen. Dazu muss eine 15-tägige Testversion von RoboHelp Office 2002 geladen werden! Wie ich Ostern 2007 erfahren musste, ist RoboHelp in der Version 6 nun von Adobe.
Seit Oktober 2002 gibt es ein Diskussionsforum zu RoboHelp, das von Jörg Ertelt und Stefan Schäffler in Deutsch betreut wird.
Ein Download einer 15-Tage-Testversion (ca. 52 MByte) war früher auch möglich.
Artikel Teil 1, Teil 2 und Teil 3 von Zoschke Data über diverse Autorentools.

Help 2.0 von Microsoft

In der Mitgliederzeitschrift "technische kommunikation 2/2002" (siehe unter www.tekom.de) fand ich einen ausführlichen Artikel von Jörg Ertelt über dieses neue Hilfesystem von Microsoft. Eine Gegenüberstellung der Version HTML Help 1.x mit der projektierten Version Help 2.0 gibt einen Eindruck von den Fähigkeiten und Neuerungen. Hier möchte und kann ich auf Details noch nicht eingehen, aber vielleicht helfen ja die Links in meiner Download Area vorerst weiter. Die Freigabe seitens MS soll erst im Jahre 2003 erfolgen. Bis dahin wird man sich mit diversen Hilfsmitteln an diese Tools heranmachen müssen. Als Hinweis sei angemerkt, dass auch für die Testumgebung ein IE ab der Version 5.x installiert sein muss.

Microsoft beendet Entwicklung an HTML Help2

Microsoft wird den lang angekündigten und immer wieder verschobenen Hilfe-Compiler HTMLHelp2 nicht mehr weiterentwickeln. Auszug aus einer Pressemitteilung von Microsoft (Februar 2003):

Shane McRoberts, Lead Program Manager for Microsoft Help, announced the following news:
The Microsoft® Help team has decided not to release Microsoft Help 2 as a general Help platform. This is primarily in response to customer feedback that the most important thing is providing a standard Help experience on everybody s machine. With that in mind, we are focusing our work efforts on providing a great Help experience in the next client release of Windows (codename: Longhorn, real name: Vista) rather than on releasing an interim solution that is not integrated with the operating system.
While Microsoft develops future Help technologies, we encourage Help authors to continue using HTML Help 1.x. Visual Studio® .NET has great support for integrating HTML Help 1.x content into the applications you build, see
http://msdn.microsoft.com/library/default.asp?url=/library/en-us/vbcon/html/vbconApplicationAssistance.asp . There are also many 3rd party tools available that provide a rich authoring experience for HTML Help 1.x content (for some examples, see WinWriters).
The Help 2 engine will continue to be provided with several of Microsofts developer-related products, including Visual Studio .NET, MSDN® Library, Microsoft .NET Framework SDK, and Microsoft Office Developer. Component developers and others who need to integrate their Help content into the Help system in Visual Studio .NET can do so using the Visual Studio Help Integration Kit (VSHIK). See
http://msdn.microsoft.com/library/default.asp?url=/library/en-us/htmlhelp/html/hwmscExtendingNETHelp.asp for more information.

Links zu Help 2.0

Die Links öffnen jeweils eine neue Browserseite.
www.mvps.org/htmlhelpcenter (Download Converter und Viewer)
www.helpware.net/mshelp2 (Info-Sammlung)
www.comet-doku.info (Deutsch, sehr ausführlicher Beitrag von Sissi Closs)
www.armadaonline.co.uk (Übersicht und Downloads)
groups.yahoo.com/group/MSHelp2 (Mailingliste)
www.winwriters.com/mshelp.htm (Vortrag von Matthew Ellison)
www.help-info.de (Homepage von Ulrich Kulle, der u.a. die Features von Help 2.0 zeigt)
http://www.help-guide.de/h2_info.htm Im März 2006 bei der Aktualisierung meiner Links bin ich auf diese deutschsprachige Site von Thomas Schulz gekommen.

Online Dokumente im Portable Document Format (PDF)

Dokumentation lässt sich auch als PDF-File generieren. Dazu gibt es (bei Verwendung von MS Word und Adobe Acrobat) zwei Möglichkeiten: Ausdruck von Word (7.0) in den PDFWriter, wodurch leider ein neuer Seitenumbruch erzeugt wird, als unter einem 600dpi-Laserdruckertreiber; und als zweites das nachträgliche Konvertieren (mit Acrobat Distiller) von PostScript-Dateien (erzeugt mit einem PS-Druckertreiber) nach PDF sowie einer Nachbearbeitung bzgl. Seitenbeschnitt. Größere Probleme haben die zahlreichen Screenshots bereitet, die bei hoher Komprimierung unerkennbar wurden und bei geringer Komprimierung zu untragbar großen Dateien geführt haben. Mit der Einstellung 96 dpi ist allerdings eine viel versprechende Lösung gefunden.
Durch Diskussionen in einer Newsgroup und Mails von Lutz angeregt, muss ich bzgl. Generierung von PDF aus Word heraus im Februar 2001 folgende Ergänzung vornehmen. Ich habe in der Zwischenzeit festgestellt, dass mein Word95 (7.0) zwar PDFs über den Button oder auch einen Eintrag im Menü 'Datei' generiert, dabei aber keinerlei Optionen zum Ausgabeformat lässt. Nach der Generierung eines PDFs steht als Drucker der PDFWriter.
Aber seit Word97 (8.0) sieht die Sache ganz anders aus! Nach Klick auf den Button oder über Datei/Adobe PDF erstellen... kommt tatsächlich der Zwischendialog 'Acrobat(r) PDFMaker 4.05 für Microsoft(r) Word' hoch und gibt ne Auswahl zwischen PDFWriter und Distiller. Tja, nun müsste man mich nur noch dazu bringen, Word97 zu verwenden. Wegen der Probleme der Grafik-Einbindungen verzichte ich jedoch, solange es geht. Dummerweise werden nämlich beim Import von Word95-Dokumenten die Grafik-Links in das Word97-Format gewandelt, womit also auch eine schnelle Ausgabe nach PDF nicht gewährleistet ist und daher mein Weg über die (E)PS-Dateien unter Verzicht auf automatische Inhaltsverzeichniserstellung im Endeffekt günstiger erscheint. Nun im Jahre 2004 habe ich mich allerdings von Word 95 verabschiedet und arbeite mit Word 2003. Das behandelt meine Grafik-Links wieder, wie ich es will. Allerdings klappt die Zusammenarbeit mit Adobe Acrobat 4.05 gar nicht mehr. Seit 2005 verwende ich Office 2003 in Verbindung mit Acrobat 7. Zum Erstellen von PDF verwende ich den Distiller-Drucker, aber keine Buttons aus dem Office-Paket.
Einen ähnlichen Weg nutze ich auch, um aus FrameMaker (9.x) mittels Acrobat (9.x) PDFs zu erstellen, die mit einem Zertifikat verschlüsselt werden und somit nicht unerlaubt verwendet werden können. Noch in 2010 werde ich solche PDFs mit Videosequenzen aufpeppen, die ich mit Captivate erzeugt habe. So bekommt auch ein statisches PDF seine Dynamik.

Links zu PDF

Adobe, zum Thema Konvertierung von PDF in andere Formate (RTF, HTML)
PlanetPDF
PDFStore mit BCL Drake 4.0
Website von Transcom zum Thema Konvertierung von Word zu PDF mit kostenlosem Tool.

Online-Hilfe mit Animationen

Ich habe länger überlegt, ob das Thema überhaupt zu Online-Hilfe gehört, aber nun bin ich der Meinung, es kann jeden Hilfe-Autor einmal treffen. Problem: Man möchte Bildersequenzen automatisch abspielen, um z.B. bei der Software-Dokumentation den Ablauf im Bild zu zeigen. Immer getreu dem Motto: Ein Film sagt mehr als hundert Bilder und mehr als tausend Worte.
Im Januar 2008 hat sich Marc Achtelig in dem Artikel Software-Demos unkompliziert erstellen, technische kommunikation 01/08 mit diesem Thema befasst. Ich möchte diese Werkzeuge auch hier erwähnen:

BBFlashBack 1.5.5 bietet zahlreiche innovative Funktionen im Detail und benötigt rel. wenig Einarbeitungszeit. Jedoch ist dieses Produkt von Blueberry mit 199 US$ nicht gerade kostenlos. Es ist keine Szenennavigation möglich, nachträglich Änderungen sind schwierig und Animationen fast nicht vorhanden.

Camtasia Studio 5 bietet eine große Anzahl unterstützter Ausgabeformate, kann auch “echte” Videos integrieren, hat hilfreiche Funktionen zur Audio-Qualitätsverbesserung, aber leider kaum Funktionen zur Interaktivität, lagert Navigationselemente in Flash-File aus (schwierig in Online-Hilfen zu integrieren), lässt Ausgabe nur noch geringfügig ändern.

Captivate 5 von Adobe. Als Teil der TCS konnte ich dieses Tool bereits kennenlernen (allerdings in Version 4). Der Funktionsumfang ist sensationell, kann man doch verschiedenste Ausgabeformate erzeugen, nachträglich vertonen, eine Text-2-Speech-Engine nutzen, um Sätze durch den Computer “sprechen” zu lassen. Bei der Aufnahme werden Einzelbilder genommen. Das hat den Vorteil, dass man sich nicht unter Druck setzen lassen muss, eine Aufnahme möglichst “rund” zu gestalten. Captivate interpoliert die Mausbewegung zwischen zwei Bildern.

DemoBuilder 6 Professional zeigt eine ungewohnte, aber sehr aufgeräumte Benutzeroberfläche. Desktop kann für die Filmaufzeichnung leergeräumt werden. Sehr einfache, effiziente Bedienung, optishc ansprechend, änderungsfreundliche, übersetzbare Ergebnisse, deutschsprachig. Aber Skins sind nur begrenzt anpassbar.

Jing von TechSmith ist in einer freien Version verfügbar. Mit diesem Tool kann ein beliebiger Bereich des Bildschirms ausgewählt werden, um die Aufnahme vorzunehmen. Eine synchrone Tonaufnahme kann ebenfalls erfolgen. Nachvertonung ist allerdings (in der freien Version) nicht möglich. Das erstellt SWF-Video hat eine sehr gute Qualität. Es gibt eine Version für Windows sowie eine für MacOS.

MadCap Mimic 1.1 ermöglicht eine sehr effiziente Arbeitsweise, bietet änderungsfreundliche Ergebnisse und vorbildliche Beispiele, hat aber eine gewöhnungsbedürftige Bedienung, keine Importschnittstelle und nur eine begrenzte Zahl unterstützter Ausgabeformate.

My Screen Recorder 2.6.3 erstellt AVI-Files, die sich dann mit entsprechenden Tools weiter bearbeiten oder in andere Formate wandeln lassen.

TurboDemo 7.5 Professional kann den Capture-Bereich sogar während der Aufnahme verändern, bietet guten Word-Export sowie zahlreiche Formate bei einfacher Bedienung, aber ist recht teuer, bietet keine Szenennavigation und keine Timeline.

Die weltweit schnellste Software für Grafik/Illustration, Layout und Bildbearbeitung erscheint nicht nur in neuer Versionsnummer, sondern zum ersten Mal komplett in deutscher Sprache: Das neue Xara Xtreme PRO 3.2 setzt die 15-jährige Entwicklungstradition des englischen Vektorgrafik-Pioniers Xara, seit Januar 2007 hundertprozentige Tochter der Magix AG, erfolgreich fort. Dank schneller Algorithmen spart Xara Xtreme PRO 3.2 bei der professionellen Erstellung fotorealistischer Illustrationen und anspruchsvoller Grafiken maßgeblich Zeit und Ressourcen. Änderungen und Effekte werden bereits während der Bearbeitung in Echtzeit dargestellt, sodass es keine unnötigen Wartezeiten gibt. So einfach zu bedienen, dass nicht nur ambitionierte Anwender, sondern praktisch jeder damit innerhalb weniger Minuten professionelle Vektor- und Bitmap-Grafiken, einschließlich detaillierter Textverarbeitung, erstellen kann.

Der ViewletBuilder arbeitet so, dass man mit dem Tool zunächst einzelne Screenshots inkl. Mauszeiger erstellt und diese Bilderreihe dann in der Programmoberfläche bearbeitet. Aus den einzelnen Mauspositionen werden Bewegungen interpoliert. Zu jedem Bild lassen sich Anmerkungen einfügen, Sprechblasen, Pausefunktion und sicherlich noch mehr. Alle Einzelbilder lassen sich dann per Knopfdruck zu einem Macromedia Shockwave Film kompilieren. Man erhält relativ kompakte Dateien (.swf) nebst einer Startdatei im HTML-Format. Bei der früher einmal kostenlosen Demo-Version muss man es allerdings hinnehmen, dass die Firma Qarbon.inc ihr Logo als Wasserzeichen in die Animation einbaut und ein Pro- und Epilog einfügt. Damit kann man aber - denke ich - gut leben. Ferner ist das Tool einfach zu bedienen. Ich habe die Anleitung (PDF-Dokument und sogar integrierte Online-Hilfe) nie benutzt. Die Anforderungen an den Arbeitsplatz-PC des Autors sind auch nicht gigantisch. Ich habe meinen Pentium 266 mit Windows NT 4.0 SP6 und 128 MB RAM genutzt. Damit klappt es immerhin. Klar, dass mehr Power zu bequemerem Arbeiten beiträgt.

WildPresenter Pro 3.4 bietet ein breites Anwendungsspektrum, hervorragende Importfunktionen sogar für editierbare PowerPoint-Präsentationen, leider jedoch eine Bedienung, die eine umfangreiche Einarbeitung notwendig macht, wenig Automatisierung und keinen durchgängigen Unicode.
Laut Website des Herstellers heißt der Nachfolger Flair und ist als Demo von dort downloadbar.

Wink 2.0 scheint als einzige kostenlose Software auch professionellen Ansprüchen zu genügen. Wink erzeugt einen anpassbaren Output im Flashformat (.swf).

Links zu Animationen

BBFlashBack von Blueberry, 199 US$.
Camtasia von TechSmith, 299 US$.
Captivate von Adobe, 799 US$.
Demo Builder von Tanida, 249 US$.
Jing von TechSmith.
MadCap Mimic von MadCap, 299 US$.
My Screen Recorder von Snapfiles, ca. 40 US$.
ViewletBuilder von Qarbon.
TurboDemo von balesio, 599 EUR.
WildPresenter von Wildform, 499 US$. Der Link verweist auf Topshareware, weil Presenter im Januar 2008 nicht mehr von Wildform vertrieben wird.
Wink: von Satish Kumar, kostenlose Software.
Xara Xtreme von Magix, ca. 300 EUR.

Download Area

Um unnötiges Blättern auf meiner Website zu vermeiden, stelle ich alle Dateien, die irgendwie mit der Hilfe-Erstellung zu tun haben, hier bereit.

Literatur zu Textverständlichkeit

Eine überraschend oft zitierte Website meiner früheren Webstruktur, jetzt hier wieder aufgenommen.

TechNet, das Microsoft TechCenter

Microsofts Definition, wie notwendige und optionale Parameter bei Verwendung von Kommandozeilencodes anzugeben sind.

IT-Einheiten-Umrechner

Ein kleines web-basiertes Tool zum Umrechnen beliebiger Einheiten aus dem Umfeld der Informationstechnolgie.

Last modified: 15.08.2015