{"id":260,"date":"2019-11-08T18:03:31","date_gmt":"2019-11-08T17:03:31","guid":{"rendered":"https:\/\/redml.de\/wordpress\/?page_id=260"},"modified":"2019-11-11T18:05:21","modified_gmt":"2019-11-11T17:05:21","slug":"softwaredokumentation","status":"publish","type":"page","link":"https:\/\/redml.de\/index.php\/softwaredokumentation\/","title":{"rendered":"Software cool dokumentieren"},"content":{"rendered":"\n<p class=\"wp-block-paragraph\">Jede Software ben\u00f6tigt eine Produktdokumentation.  Aber nur wenn sie <strong>cool <\/strong>ist, wird sie auch benutzt.<\/p>\n\n\n\n<p class=\"wp-block-paragraph\">Eine Softwaredokumentation ist cool, wenn die Anwender sie auf <strong>unterschiedlichen Medien<\/strong> abrufen k\u00f6nnen. H\u00e4ufig verlangt werden etwa: <\/p>\n\n\n\n<ul class=\"wp-block-list\"><li><strong>PDF <\/strong>zum Ausdrucken,<\/li><li><strong>CHM<\/strong>-Datei (Microsoft-HTML-Hilfe) f\u00fcr den lokalen Zugriff,<\/li><li><strong>WebHelp-Format <\/strong>f\u00fcr den station\u00e4ren Zugriff \u00fcber das Internet,<\/li><li><strong>Responsive HTML <\/strong>f\u00fcr den <strong>mobilen <\/strong>Zugriff \u00fcber das Internet,<\/li><li>Schrittanleitungen in kleinen <strong>How-to-Videos<\/strong>.<\/li><\/ul>\n\n\n\n<p class=\"wp-block-paragraph\">Mit dem richtigen <strong>Workflow <\/strong>lassen sich diese unterschiedlichen Ausgabeformate weitgehend aus einer Quelle erstellen.<\/p>\n\n\n\n<ol class=\"wp-block-list\"><li>Erstellen der Dokumentation in Microsoft <strong>Word <\/strong>auf der Basis einer geeigneten Dokumentvorlage.<\/li><li><strong>PDF <\/strong>aus Word heraus erstellen. <\/li><li>Die Word-Dokumente in Adobe <strong>RoboHelp <\/strong>importieren. <\/li><li>Aus RoboHelp heraus lassen sich unter anderem die Formate <strong>CHM, WebHelp <\/strong>und <strong>Responsive HTML5<\/strong> erstellen. <\/li><li>Schrittanleitungen bilden die Drehb\u00fccher f\u00fcr How-to-Videos. Diese lassen sich beispielsweise mit Adobe <strong>Captivate <\/strong>erstellen. Captivate kann Ausgaben in HTML5 oder <strong>MP4 <\/strong>erzeugen. Links zu den Videos lassen sich als URL oder <strong>QR-Code<\/strong> in die anderen Dokumente einbetten.<\/li><\/ol>\n\n\n\n<p class=\"wp-block-paragraph\">Als kleines <strong>Beispiel <\/strong>f\u00fcr diesen Workflow habe ich auf diese Weise ein Mini-Handbuch erstellt: <em>Mit Word-Makros arbeiten<\/em>. Die Dokumentation ist hier verf\u00fcgbar als:<\/p>\n\n\n\n<ul class=\"wp-block-list\"><li><a href=\"https:\/\/redml.de\/wordpress\/wp-content\/uploads\/2019\/11\/MitWordMakrosArbeiten.pdf\">PDF-Datei<\/a><\/li><li><a href=\"https:\/\/www.redml.de\/webhelp\/MitWordMakrosArbeiten\/\">WebHelp<\/a><\/li><li><a href=\"https:\/\/www.redml.de\/Responsive\/MitWordMakrosArbeiten\">Responsive HTML5<\/a> <\/li><li>Die Schrittfolge &#8222;Ein Word-Makro aufzeichnen&#8220; als <br><a href=\"https:\/\/redml.de\/videos\/WordMakroAufzeichnen\/index.html\">How-to-Video im HTML5-Format<\/a> und als <a href=\"https:\/\/youtu.be\/fctVO8pXNoE\">Youtube-Video<\/a><\/li><\/ul>\n\n\n\n<p class=\"wp-block-paragraph\">Das Erstellen einer solchen <strong>coolen<\/strong> Produktdokumentation in <strong>mehreren Ausgabeformaten<\/strong> muss keinen Riesenaufwand erfordern.  <\/p>\n\n\n\n<p class=\"wp-block-paragraph\">Und <strong>cool<\/strong> muss sie sein. Denn sonst werden Ihre Anwender sie nicht <strong>nutzen wollen<\/strong>.<\/p>\n","protected":false},"excerpt":{"rendered":"<p>Jede Software ben\u00f6tigt eine Produktdokumentation. Aber nur wenn sie cool ist, wird sie auch benutzt. Eine Softwaredokumentation ist cool, wenn&hellip;<\/p>\n","protected":false},"author":1,"featured_media":0,"parent":0,"menu_order":0,"comment_status":"closed","ping_status":"closed","template":"","meta":{"footnotes":""},"class_list":["post-260","page","type-page","status-publish","hentry"],"_links":{"self":[{"href":"https:\/\/redml.de\/index.php\/wp-json\/wp\/v2\/pages\/260","targetHints":{"allow":["GET"]}}],"collection":[{"href":"https:\/\/redml.de\/index.php\/wp-json\/wp\/v2\/pages"}],"about":[{"href":"https:\/\/redml.de\/index.php\/wp-json\/wp\/v2\/types\/page"}],"author":[{"embeddable":true,"href":"https:\/\/redml.de\/index.php\/wp-json\/wp\/v2\/users\/1"}],"replies":[{"embeddable":true,"href":"https:\/\/redml.de\/index.php\/wp-json\/wp\/v2\/comments?post=260"}],"version-history":[{"count":21,"href":"https:\/\/redml.de\/index.php\/wp-json\/wp\/v2\/pages\/260\/revisions"}],"predecessor-version":[{"id":288,"href":"https:\/\/redml.de\/index.php\/wp-json\/wp\/v2\/pages\/260\/revisions\/288"}],"wp:attachment":[{"href":"https:\/\/redml.de\/index.php\/wp-json\/wp\/v2\/media?parent=260"}],"curies":[{"name":"wp","href":"https:\/\/api.w.org\/{rel}","templated":true}]}}