Redaktionsleitfäden und Strukturvorlagen

Wir entwerfen und erstellen Strukturvorlagen, Redaktionsleitfäden, DTDs, XML Schemas und andere Gestaltungsrichtlinien für Handbücher, Online-Hilfen und andere Formen Technischer Dokumentation, insbesondere Software-Dokumentation. Unser oberstes Prinzip dabei ist stets, alle Regeln so einfach und alle Strukturen so flach wie möglich zu halten.

Arbeiten an Ihren Dokumentationsprojekten mehrere Autoren? Schwankt die Qualität der Ergebnisse? Benötigen Sie klare Gestaltungsrichtlinien und einen einheitlichen Dokumentations-Standard?

Falls Sie XML-strukturierte Dokumentation erstellen: Benötigen Sie vielleicht sogar eine DTD (FrameMaker EDD / XML Schema) oder eine Spezialisierung (Anpassung) von DITA?

Im ersten Schritt analysieren wir eingehend alle Anforderungen, die sich seitens Ihrer Kunden sowie seitens Ihrer Entwicklungs- und Vertriebsprozesse ergeben. Auf dieser Grundlage entwickeln wir einen übersichtlichen Baukasten an Informationsmodulen und Regeln (Redaktionsleitfaden, Styleguide, Gestaltungsrichtlinie). Dieser Baukasten bildet die gemeinsame Basis, auf der zukünftig alle Autoren einheitliche, gleichbleibend hochwertige und benutzerfreundliche Dokumente erstellen können.

Die Informationsbausteine sind so konzipiert, dass sie bei Bedarf in unterschiedlichen Dokumenten wiederverwendet werden können (Prinzip des Single Source Publishing). Dabei sind die Strukturen so aufgebaut, dass sowohl große Einheiten wiederverwendet werden können (ganze Topics oder Kapitel) als auch sehr feingranulare Einheiten (einzelne Absätze).

Viele Strukturen erweisen sich in der Praxis als viel zu komplex und unübersichtlich. Nicht selten verlieren die Autoren mit solchen Regelwerken in Summe mehr Zeit, als sie gewinnen. Unser wichtigstes Erfolgskriterium für eine DTD / ein Schema sind daher übersichtliche Strukturen und eine optimale Ergonomie für den Autor. Je weniger Regeln und Elemente erforderlich sind, je flacher die Elementhierarchie gehalten werden kann, desto besser.

 

 

Gerne erstellen wir Ihnen ein individuelles Angebot. Unsere Kontaktdaten finden Sie hier.

Schlüsselwörter zu dieser Seite: Technische Dokumentation - Software-Dokumentation - Softwaredokumentation - Benutzerdokumentation - Redaktionsleitfaden - Redaktionsleitfäden - Redaktionsstandard - Redaktionsstandards - Redaktionshandbuch - Redaktionshandbücher - Writing Style Guide - Styleguide - Gestaltungsrichtlinie - Strukturvorlage - DTD - Schema - XML Schema - DITA - Informationsdesign - Erstellung - erstellen - Entwicklung - entwickeln.

 

Impressum | Copyright | Nutzungsbedingungen | Links auf unsere Seiten | Danksagung

Newsfeed abonnieren Newsfeed

Bookmark and Share
Software-Dokumentation
seit 1989.
Zahlreiche Fachvorträge und Publikationen zum Thema Technische Dokumentation und Software User Assistance.
Goldene Diskette des Computermagazins CHIP.
Mitglied im deutschen Fachverband für Technische Kommunikation und Informationsentwicklung.
Intro zeigen (80 Sek.):  Abspielen