MadCap Central: Bereit zur Abfahrt 14.12.201603.11.2018 Im dritten Teil geht es um das Publizieren und Versionieren: Wer darf welche Informationen veröffentlichen, in welcher Form und wohin? Und wie „friert“ man einen Stand ein – und taut ihn wieder auf? Gleich vorweg: Dokumente in Flare (und in Central) werden nicht publiziert, sondern erst „gebaut“ und dann verteilt. Das ist technisch korrekter, denn statt des Druckens werden die Dokumente in Central wie auch in Flare „on the fly“ aus den dafür freigegebenen Topics zusammengesetzt und mit Hilfe der CSS formatiert. Das bedeutet aber auch, dass alle Einstellungen zu Formaten, Layout, Ausgabemedien, etc. bereits vorhanden sein müssen, bevor in Central die Dokumentenproduktion anlaufen kann. Diese Einstellungen nimmt der Redakteur in Flare vor und gleicht sie als „Targets“ mit Central ab. „Bauen“ Das „Build management“ in Central. Hier wird die Produktion angestoßen (und protokolliert). Ein Benutzer – sofern er über die entsprechenden Berechtigungen verfügt – wählt das Projekt (also die Dokumentation) aus, die erstellt werden soll, und wählt dann das gewünschte Target. Central erstellt daraufhin auf dem Server die Dokumentation. Das ist insofern clever, als dass damit der Produktionsprozess keine eigene Software mehr verlangt. Jeder Benutzer mit der entsprechenden Berechtigung (also auch ein Vertriebsleiter in Singapur, der sonst nichts mit der Dokumentation zu tun hat), kann sich beispielsweise eine PDF des aktuellen Status erstellen lassen. Sogar zeitgesteuert. Die Dokumente stehen nach der Erstellung entweder zum Download zur Verfügung oder können in einen Zielordner („Destination“) kopiert werden. Dieses Ziel wird in Flare definiert und kann beispielsweise der Internetserver des Unternehmens sein. Das bedeutet, dass der Vertriebsleiter zu jeder Zeit die Dokumentation auf dem Server des Unternehmens aktualisieren kann – sei es nun eine komplette HTML-Dokumentation oder ein fertig gelayoutetes PDF. Versionieren fertiger Dokumente Mehrere Versionen aufheben Normalerweise überschreibt der Server bei jedem Erstellungsprozess die bereits vorhandenen Dateien. Das spart Platz und soll verhindern, dass man vor lauter Dokumenten die Übersicht verliert – vor allem, wenn sie während des Korrekturprozesses erstellt werden und noch keine finalen Fassungen sind. Um sich aber wichtige Zwischen- oder Endfassungen aufzubewahren, setzt man in Central ein Häkchen („Keep“) vor das Dokument. Damit wird es aufbewahrt und kann gegebenenfalls live geschaltet werden, also auf einen Server publiziert, der öffentlich verfügbar ist. Sollte der Vertriebsleiter beispielsweise feststellen, dass eine neu hinzugekommene Information im aktuellen Dokument fehlerhaft ist, lässt sich so ohne erneuten Upload und Download das Dokument auf dem Unternehmensserver austauschen: Dazu muss nur die noch aufbewahrte Fassung live geschaltet werden. Dann wandert die fehlerhafte Fassung zurück in „Aufbewahren“ und kann gelöscht werden. Immer Bescheid wissen In einem Szenario, bei dem so beispielsweise der Vertriebsleiter in Singapur merkt, dass ein Fehler in der Übersetzung ist, zieht er die fehlerhafte Fassung aus dem Verkehr und tauscht sie gegen eine korrekte, aber ältere Fassung aus. Nach der Korrektur wird die neue Fassung dann wieder online gestellt und die ältere Fassung bleibt im Archiv. Der Redakteur (und alle anderen Beteiligten) bekommen dazu eine Meldung per E‑Mail oder im Nachrichtenfenster. Oder beides. Und noch besser: Dazu muss der Redakteur noch nicht einmal aufstehen. Teilen mit:MastodonWhatsAppE‑MailMehrDruckenLinkedInTelegramPinterestGefällt mir:Gefällt mir Wird geladen … technische dokumentation FlareMadCap
dokumentation InDesign CC: Noch etwas GREP gefällig? 21.02.201719.12.2020 InDesign ist ein mächtiges Layoutwerkzeug. In der technischen Dokumentation wird es aber meist nur dann… Teilen mit:MastodonWhatsAppE‑MailMehrDruckenLinkedInTelegramPinterestGefällt mir:Gefällt mir Wird geladen … Read More
redaktion Tech docs don’t sell 30.03.201818.04.2018 Wenn sich schon Technische Dokumentation schlecht verkauft, müssen wir es nicht auch tun. Teilen mit:MastodonWhatsAppE‑MailMehrDruckenLinkedInTelegramPinterestGefällt mir:Gefällt mir Wird geladen … Read More
online publishing Onlinehilfen: Form follows function 31.12.202302.01.2024 Das funktionale Layout ist auch im Internet ein wichtiger Aspekt für die Verständlichkeit und Lesbarkeit technischer Dokumentation. Teilen mit:MastodonWhatsAppE‑MailMehrDruckenLinkedInTelegramPinterestGefällt mir:Gefällt mir Wird geladen … Read More