Fachportal für Technische Dokumentation

Handbuch & Online-Doku

Trendige Dokumentation und DITA 1.2

DITA war gestern, mobil ist heute? Smartphone, IPad & Co haben die Doku-Welt wieder einmal kräftig aufgerüttelt. Alles dreht sich nur noch um die schönen kleinen Geräte, die uns überall und zu jeder Zeit begleiten. Kann da ein spröder XML-Standard noch mithalten?

Dokumentation auf mobilen Endgeräten - Neuauflage für das Single Sourcing

Inhalte und Anwendungen auf Tablet-PCs und Smartphones mausern sich von unterhaltsamen Zusatzfunktionen zu wichtigen Informationsträgern, gerade auch für die Technische Dokumentation.

RoboHelp 9 - Hilfen und E-Books im ePub-Format ausgeben

Mit RoboHelp 9 können Sie Ihre Dokumentation im XML-basierten Standard ePub ausgeben, der vor allem für die Anzeige auf mobilen Geräten nützlich ist. Die Darstellung wird je nach Gerät und Displaygröße angepasst und unterstützt auf Smartphones und Tablet-PCs zumeist die Navigation mittels Touchscreen.

The Evolution of Technical Documentation

At the end of the 70s, monitors were still green, text was written by hand or typewriter, screenshots were made using an analog camera, we still used hot metal in professional typesetters, and technical documentation was still distributed in folders. As an experienced writer in technical documentation, I have been swept along by the vast developments in the industry: from punched cards (which I first saw in my first semester of study), to text files with proprietary markup language on mainframe computers, to FrameMaker operating on Sun Microsystems and structured FrameMaker in Windows, right up to XML and document management systems.

Agile and eXtreme – The Future of Technical Documentation

Our products have never been highly sought-after products that people saved for, or waited impatiently to call their own. But even if they were never truly loved, they were at least considered useful, even indispensable, if you wanted to learn to use a device or a new software program. However, even this is now being called into question.

Single-Sourcing for Training and Presentation Materials

Today, businesses invest highly in the development of their business processes. However, training and presentation materials are, to a great extent, created and managed independently of other company documentation, and are often completely separated from the editorial department.

Designerfreundliches App-Publishing für iPads

Die Firma Quark bietet mit verschiedenen, sich ergänzenden Programmen eine umfassende Lösung für das Dynamic- und Digital-Publishing für mittlere bis große Unternehmen an. Basis bildet das redaktionelle Workflow-System Quark Publishing System®. Für dieses ist seit Kurzem die Komponente "App Studio" erhältlich.

Neuer Weg in der Benutzerunterstützung: „Moment of Need”-Content

Als „Moment of Need“-Content bezeichnet man Inhalt, der dem Benutzer unmittelbar während seiner täglichen Arbeit Informationen oder Support liefert. Eine Schlüsselfunktion dabei ist, dem User das Suchen nach Hilfe zu ersparen, indem die richtigen Antworten genau am richtigen Ort angezeigt werden. Der Artikel von Paul Trotter erklärt die Eigenschaften von „Moment of Need“-Inhalt und zeigt die Vorteile für dessen Einführung auf. Paul Trotter ist CEO und Gründer der Firma Author-it Software Corporation.

Using Standardization for Success - Where is Standardization Required?

Standards are a proven method of achieving uniformity and making documentation easier to manage for everyone involved.

Technical Documentation for Web Applications

What are Web applications and how does the Web change documentation?

DITA-basierte Publikationsprozesse mit der Dynamic Publishing Solution von Quark®

Die Dynamic Publishing Solution von Quark® erleichtert die Einführung von XML-basierten Publishingprozessen unter Anwendung von DITA in der Technischen Dokumentation, indem sie den Benutzern das Erstellen von XML-Inhalten in der vertrauten Umgebung von Microsoft Word ermöglicht. Die Speicherung und Archivierung von Inhalten kann über Microsoft SharePoint erfolgen.

Aus MS Word wird XML: mit dem Quark® XML Author

XML ist für die Technische Dokumentation von großem Vorteil, da es die Wiederverwendung von Informationskomponenten und die Publikation in unterschiedliche Zielmedien ermöglicht. Das Erstellen im XML-Format gestaltet sich jedoch oft komplex, erfordert Fachkenntnisse und eigene Tools. Die Firma Quark bietet mit dem XML Author die Möglichkeit, komplexe XML-Dokumente über Word zu erstellen und Standards wie DITA anzuwenden.

RoboHelp 8: Baggage-Dateien - das leichte Handgepäck für Ihre Hilfe

Baggage-Dateien umgibt ein etwas geheimnisvolles Image, denn ihre Daseinsberechtigung offenbart sich nicht auf Anhieb. In der Dokumentation zu RoboHelp werden sie schlicht als „Referenzen auf externe Elemente“ bezeichnet. Nachfolgend wollen wir anhand einiger Beispiele aufzeigen, wozu Baggage-Dateien nützlich sind und wie man sie in der Online-Hilfe einsetzen kann.

OpenOffice Writer - Buchfunktionen der Programmversion 3

Wer umfangreiche Texte wie ein Handbuch erstellen will, kann sich die Buchfunktion verschiedener Programme zunutze machen. Auch OpenOffice Writer bietet eine solche Buchfunktion, die dieser Beitrag in einigen Punkten näher beleuchtet.

FrameMaker 9 – neue und erweiterte Funktionen

Adobe FrameMaker ist eine professionelle Authoring- und Publishing-Lösung für die Erstellung und Veröffentlichung Technischer Dokumentationen. Nachdem erst 2007 Adobe FrameMaker 8 herauskam, hat Adobe nun nach kurzer Zeit wieder eine neue Version des beliebten Autorenwerkzeugs auf den Markt gebracht. Mit FrameMaker 9 ist das Erstellen und Veröffentlichen von Dokumentationen noch einfacher, schneller und effizienter möglich. Im Folgenden werden die wichtigsten Neuerungen des DTP-Programms beschrieben.

Änderungsmarkierungen in OpenOffice Writer und Word 2003

Nicht jeder hat auf seinem Computer Microsoft Word installiert, muss jedoch vielleicht mit anderen zusammenarbeiten, die nur Word haben. Inzwischen scheint diese Zusammenarbeit kein Problem mehr zu sein.

Das Verb macht´s – zur Bedeutung von Verben in der Anwendungsdokumentation

Vortrag von Ageliki Ikonomidis auf der tekom-Jahrestagung am 9. November 2007 in Wiesbaden.

Ein Doku-Dinosaurier erinnert sich

Damals Ende der 70er Jahre waren die Monitore noch grün, Text wurde per Hand oder Schreibmaschine geschrieben, Screenshots mit analoger Kamera angefertigt, es gab noch Bleisatz mit professionellen Setzern, und die Technische Dokumentation wurde noch in Aktenordnern ausgeliefert. Als Doku-Dinosaurier habe ich die ganze Entwicklung mitgemacht: vom Lochkartenstanzer (mit dem ich im 1. Studiensemester noch in Berührung gekommen bin) über Textdateien mit proprietären Auszeichnungssprachen auf Großrechnern, FrameMaker auf der Sun, strukturiertem FrameMaker unter Windows bis hin zu XML und Dokumentenmanagementsystemen.

RoboHelp 7

Lange Zeit blieb es um das beliebte Online-Hilfe-Werkzeug RoboHelp ruhig. Nach der Übernahme von eHelp durch Macromedia und von Macromedia durch Adobe prophezeiten Gerüchte sogar die Einstellung von RoboHelp. Das diente nicht gerade zur Beruhigung der Anwenderschaft. Doch mit RoboHelp 7 ist Adobe nun ein großer Wurf gelungen und die Integration in die Technical Communication Suite macht das Programm auf einen Schlag zum neuen Flaggschiff.

Wie geht es mit DITA weiter?

Vortrag von Prof. Sissi Closs auf der tekom-Jahrestagung am 8. November 2007 in Wiesbaden.

Information für alle – Barrierefreiheit in der EDV

Die Gleichstellung behinderter Menschen scheint längst zur Selbstverständlichkeit einer offenen und modernen Gesellschaft geworden zu sein. Tatsächlich fand in Deutschland erst 1994 die Gleichstellung behinderter Menschen Eingang ins Grundgesetz. Seit 2002 legt das Behindertengleichstellungsgesetz (BGG) die Anforderungen und Bedingungen für eine barrierefreie Welt für behinderte oder beeinträchtigte Menschen fest. Wie sich diese Anforderungen auf die Informationstechnik auswirken, erläutert dieser Beitrag.

Agil und eXtrem - die Zukunft der Technischen Dokumentation

Noch nie waren unsere Produkte solche, nach denen man sich sehnt, für die man sein Geld spart, auf die man ungeduldig wartet, bis man sie endlich sein Eigen nennen darf. Auch wenn sie nie geliebt wurden, so galten sie doch als nützlich, ja sogar unabkömmlich, wollte man sich mit einem Gerät oder einer Software vertraut machen. Aber jetzt wird sogar dieses in Frage gestellt.

Wichtige Tools für Online-Hilfen

Der Markt an Autorenwerkzeugen für die Technische Dokumentation ist vielfältig. Eine Zusammenstellung wichtiger Tools.

Word 97 – Index erstellen

In einem Index sind die im Dokument behandelten Begriffe und Themen mit den dazugehörigen Seitenzahlen aufgelistet. Wählen Sie zum Erstellen eines Index die Kernbegriffe Ihres Dokuments aus. Achten Sie darauf, dass diese im Text näher erläutert sind. So können die Leser gezielt im Index zu wichtigen Themen und Begriffen nachschlagen, über die sie sich informieren wollen.

Single Sourcing auch für Schulungs- und Präsentationsunterlagen

Unternehmen investieren heute viel in die Gestaltung ihrer Geschäftsprozesse. Präsentations- und Schulungsunterlagen werden jedoch weitgehend isoliert von der restlichen Dokumentation im Unternehmen erstellt und verwaltet, häufig völlig getrennt von der eigentlichen Redaktion.

Interface-Usability im World Wide Web

Gutes User-Interface-Design und schlüssige Informationsarchitektur helfen Nutzern, sich zurechtzufinden und veranlassen sie, gerne zu einer Website zurückzukehren. Bedienfreundlichkeit im World Wide Web ist keineswegs selbstverständlich.

Mit Standardisierung zum Erfolg - Wo brauchen wir Standards?

Standards sind bewährte Mittel, Vereinheitlichung zu erreichen und die Handhabung von Dokumenten für alle zu vereinfachen.

Technische Dokumentation für Web-Anwendungen

Was sind Web-Anwendungen und wie verändert das Web die Dokumentation?

Effektive User-Assistance

User-Assistance ist der Oberbegriff für alle Bemühungen, Menschen bei der Nutzung eines Produkts zu unterstützen.

Interactive WebHelp

Comet, one of the leading providers of technical documentation in Germany developed a customized solution for a WebHelp-based information portal. It offers information about a training center and its courses. We integrated a database-based solution to update course information interactively, as required. Vortrag tekom-Jahrestagung 2004 - Prof. Sissi Closs

Kompakt und inhaltsreich - moderne Informationsdarstellung in OnlineHilfe-Systemen

OnlineHilfe-Systeme sind bei steigender Komplexität nur dann eine Hilfe, wenn die Informationen in einer mediengerechten Form präsentiert werden. Vortrag tekom-Jahrestagung 2004 - Günter Starkmann

Writing comprehensive single-source English

The quality, reusability and translatability of documentation have become increasingly important. A logical writing system for English as the source language is imperative.

Schulungsunterlagen und Single-Source-Publishing - Wie passt das zusammen?

Comet Communication verwaltet mit Author-it die eigenen Schulungsunterlagen. Dank Single-Source-Publishing können diese effizient aktualisiert und in unterschiedlichen Formaten publiziert werden. Vortrag - Zweites deutsches Single-Source-Forum 2002 - Gabriele Jung

Sie finden keine Artikel zum bestimmten Thema?
Dann schicken Sie einfach Ihren Wunsch an uns.


Suche



Themenbereich:

Werbung

Nicht verpassen
Dokumentation auf mobilen Endgeräten - Neuauflage für das Single Sourcing

Hilfe im Zeitalter des Web 2.0 - Social Media in der Praxis

Startschuss für das Terminologiemanagement

Startseite | Impressum | Kontakt

[XML-RSS]

Doku.Info ist ein Service von Comet Computer GmbH - Die Profis für Technische Dokumentation