#28284
Marktüberblick Autorenwerkzeuge für Online-Hilfen
Marktüberblick über empfehlenswerte Tools zum Erstellen von Software-Dokumentation (Handbücher, Online-Hilfen). Viele dieser Help Authoring Tools unterstützen das Generieren druckbarer Handbücher (PDF) und Online-Hilfen aus einer gemeinsamen Text-Quelle (Prinzip des Single Source Publishing).
Achtelig, Marc. indoition engineering. (German) Resources>Software>Help>Help
#26820
Betriebswirtschaftliche Lüsungen zur Kostensenkung Technischer Dokumentation 
Die meisten TD-Verantwortlichen besitzen einen technischen Hintergrund. Daher verwundert es nicht, dass sie Lösungen für Kostenprobleme ebenfalls in der Technik suchen: Datenbanken, Content Management oder Translation Memory. Doch die Investitionskosten sind hoch. Und oft dauert es Jahre, bis sich entsprechende Systeme amortisieren – wenn überhaupt. Ein Betriebswirtschaftler würde das Problem anders lösen: ohne Technik und ohne Investition, durch gezieltes Setzen von Prioritäten und mit optimierten Prozessen. Bewährte Ansätze aus der Betriebswirtschaft gibt es viele, denn andere Unternehmensbereiche leiden unter genau denselben Kostenproblemen. Dieser Beitrag zeigt die wichtigsten Methoden und gibt Beispiele für deren Anwendung in der Technischen Dokumentation.
Achtelig, Marc. indoition engineering (2006). (German) Articles>Management>Project Management>Workflow
#28282
Checkliste zur Qualitätssicherung Technischer Dokumentation
Einfache Checkliste zur Beurteilung und Verbesserung der Qualität Technischer Dokumentation, insbes. Technischer Dokumentation für Software (Software-Dokumentation) wie Handbücher, Online-Hilfen sowie interaktiver Demos und Tutorials.
Achtelig, Marc. indoition engineering (2006). (German) Articles>Documentation>Quality>Documentation
#26815
Google returns well over 15 million search results to the technical question of how to code hyperlinks in HTML. However, a question on how link texts should be formulated, so that the reader can understand them clearly, fetches only a handful of usable tips. Even most style guides and authoring guidelines are reticent on this topic. In this article you will find tips on this rarely dealt with, though important subject for Technical Communicators.
Achtelig, Marc. indoition engineering (2005). Articles>Writing>Document Design>Hypertext
#28281
Documentation Quality Checklist
Basic checklist for assessing and improving the quality of technical documentation, especially software documentation such as user manuals, online help files, interactive demos and tutorials.
Achtelig, Marc. indoition engineering (2006). Articles>Documentation>Quality>Documentation
#28283
Market overview of recommendable tools for creating software documentation, especially for the creation of user manuals and online help files. Many of these help authoring tools can generate printable user manuals (PDF) and onlne help files from the same text base (single source publishing principle).
Achtelig, Marc. indoition engineering. Resources>Software>Tools>Help
#26463
Basic know-how, checklists, tools and links, which will help you to write create clear and concise user-friendly manuals, online help files, software demos, tutorials and other forms of user assistance.
Achtelig, Marc. indoition engineering (2005). Resources>Information Design>Single Sourcing>Writing
#26818
Information Layering: bedarfsspezifisch informieren
Wenn Sie diesen Absatz lesen, sind Sie bereits mittendrin: im "Information Layering". Ihr Informationsbedarf: herauszufinden, ob sich die Lektüre dieses Artikels lohnt. Dazu gibt der erste, layouttechnisch hervorgehobene Absatz einen kurzen Eindruck vom Inhalt. Das erspart es Ihnen den kompletten Artikel zu überfliegen. Die Information "um was geht es?" steht vom Rest losgelöst auf einer eigenen Ebene – englisch: "layer". Während dieses einfache Beispiel seit Jahrzehnten in jeder Zeitung funktioniert, bieten moderne Online-Medien noch viel mehr Möglichkeiten Relevantes von Irrelevantem zu trennen.
Achtelig, Marc. indoition engineering (2005). (German) Articles>Information Design>Help>Hypertext
#26466
Information Layering: Providing Need-Based Information
Information Layering is not new, but it has acquired a new dimension through modern technical and interactive possibilities. Even as of now, this technique can be used to make HTML-help considerably more user friendly.
Achtelig, Marc. indoition engineering (2005). Articles>Documentation>User Centered Design>Online
#26819
Links Anwenderfreundlich Formulieren
Auf die Frage, wie Hyperlinks technisch in HTML zu formulieren sind, listet Google weit über 15 Millionen Treffer. Auf die Frage hingegen, wie die Linktexte gestaltet sein sollen, damit sie der Leser gut versteht, lassen sich brauchbare Empfehlungen an einer Hand abzählen. Auch die meisten Styleguides und Redaktionsleitfäden halten sich bei dieser Frage bedeckt. Im folgenden Beitrag finden Sie Tipps zu diesem wenig behandelten, aus Sicht der Technischen Dokumentation aber wichtigen Thema.
Achtelig, Marc. indoition engineering (2005). (German) Articles>Writing>Hypertext>Help
#26816
Management Methods to Lower Documentation Costs
Most people who are in charge of technical documentation have a technical background. No wonder that they look to technology for solving their cost problems: databases, content management or translation memory. But the investment costs are high, of course. And it often takes years for such systems to amortise, if at all they do. A business manager would adopt a different approach to solving the problem: without technology and without investments, by setting priorities and by using optimized processes. There are several tried and tested approaches from the domain of business management that have been succesfully used in other departments to deal with very similar problems. This article explains the most important of these methods and gives examples of how they can be applied to technical documentation.
Achtelig, Marc. indoition engineering (2006). Articles>Project Management>Management>Workflow
#26464
Grundlagenwissen, Checklisten, Tools und Links, die Ihnen beim Schreiben benutzerfreundlicher Handbücher, Online-Hilfen, Software-Demos, Tutorials und anderer Formen der Benutzerunterstützung ("User Assistance") helfen.
Achtelig, Marc. indoition engineering (2005). (German) Resources>Information Design>Technical Editing
#35339
Choosing a Help Authoring Tool
Help authoring tools (HATs) are specialized editors and converters to create online technical documentation. Today, many help authoring tools also provide features for single source publishing, which means that you can generate several output formats and versions from one shared text source. While most tools manage to produce different online formats like browser-based help and compiled help very well, only few tools can also produce printed user manuals (or PDF) of professional quality. Big differences also exist between the tools when it comes to translating your projects into foreign languages.
Achtelig, Marc. indoition engineering. Articles>Documentation>Software>Help
#35340
Choosing a Screen Capture Tool
Checklist of key criteria for selecting a tool to take screen captures (screenshots / screen dumps). Screen captures are used within all forms of software documentation, such as user manuals, online help files, interactive demos and tutorials, but also for web sites and brochures.
Marc Achtelig. indoition engineering. Articles>Documentation>Software>Screen Captures
#35341
Checklist of key criteria for selecting a tool to create interactive software demos (so-called screencasts). Software demos are not only used on web sites but increasingly also as standalone tutorials or embedded within online help files and other sorts of software documentation.
Achtelig, Marc. indoition engineering (2009). Articles>Documentation>Software>Screencasting
#35342
Market overview of recommendable tools for creating screen captures (screenshots, screen dumps). Screen captures are required within all forms of software documentation, such as user manuals, online help files, interactive demos and tutorials, but also for web sites and brochures.
Achtelig, Marc. indoition engineering. Resources>Software>Help>Screen Captures
#35344
Auswahl eines Help Authoring Tools
Checkliste der wichtigsten Kriterien für die Auswahl eines Tools zum Erstellen von Software-Dokumentation (Handbücher, Online-Hilfen) - sog. Help Authoring Tools, kurz HAT. Viele Help Authoring Tools können Benutzerhandbücher und Online-Hilfen aus einer gemeinsamen Textquelle heraus generieren (sog. Single Source Publishing).
Achtelig, Marc. indoition engineering. (German) Articles>TC>Software>Help
#35345
Auswahl eines Screen Capture Tools
Screenshots oder Screencaptures). Benötigt werden Screenshots in allen Formen von Software-Dokumentation, z.B. für Handbücher, Online-Hilfen, interaktive Demos und Tutorials, aber auch für Webseiten oder Broschüren.
Achtelig, Marc. indoition engineering. (German) Articles>TC>Help>Screen Captures
#35346
Auswahl eines Screencasting Tools
Checkliste der wichtigsten Kriterien für die Auswahl eines Tools zum Erstellen interaktiver Software-Demos (engl. Screencasts). Verwendet werden Software-Demos oder Screencasts nicht nur auf Webseiten, sondern häufig auch als Ergänzung zur Technischen Dokumentation für Software: z.B. als eigenständiges Tutorial oder auch als integrativer Bestandteil einer Online-Hilfe oder sonstiger Software-Dokumentation.
Achtelig, Marc. indoition engineering. (German) Articles>TC>Video>Screencasting
#35347
Marktüberblick Screen Capture Tools
Überblick über empfehlenswerte Tools zum Erstellen von Bildschirmfotos (engl. Screen Captures, Screenshots oder Screen Dumps). Screenshots werden in allen Formen von Software-Dokumentation benötigt, z.B. für Handbücher, Online-Hilfen, interaktive Demos und Tutorials, sowie auf Webseiten und in Broschüren.
Achtelig, Marc. indoition engineering. (German) Resources>Software>Help>Screen Captures
#35348
Marktüberblick Screencasting Tools
Marktüberblick über empfehlenswerte Tools zum Erstellen von Software-Demos (engl. Screencasts). Software-Demos werden nicht nur für Marketing-Zwecke auf Webseiten verwendet, sondern häufig auch als Ergänzung zur Technischen Dokumentation von Software: z.B. als eigenständiges Tutorial oder auch als integrativer Bestandteil einer Online-Hilfe oder sonstiger Software-Dokumentation.
Achtelig, Marc. indoition engineering. (German) Articles>Documentation>Software>Screencasting
