{"id":19872,"date":"2023-07-17T13:38:19","date_gmt":"2023-07-17T13:38:19","guid":{"rendered":"https:\/\/devologyx.io\/6-must-dos-fuer-perfekte-technische-software-dokumentation\/"},"modified":"2024-10-31T18:01:49","modified_gmt":"2024-10-31T18:01:49","slug":"6-must-dos-fuer-perfekte-technische-software-dokumentation","status":"publish","type":"post","link":"https:\/\/devologyx.io\/de\/6-must-dos-fuer-perfekte-technische-software-dokumentation\/","title":{"rendered":"6 MUST-DO&#8217;S F\u00dcR PERFEKTE TECHNISCHE SOFTWARE-DOKUMENTATION"},"content":{"rendered":"\n<figure class=\"wp-block-image is-resized\"><img fetchpriority=\"high\" decoding=\"async\" src=\"https:\/\/lh3.googleusercontent.com\/od1Y1ewzSQdGaUw6eMp6SNNDzb7YaKDJn6zUkbHE_nIgwQM2s518NS_K3FuA0_gm0ykrO-Z4pBQZbmSSrpGzri9whS5_8zSSirW7oMVRq8svlSvpEEl7heIv3DqxqiQ7ywWvpUUCBUb1vyaNFrgv0-w\" alt=\"\" width=\"416\" height=\"233\"\/><\/figure>\n\n<p>In der Softwareentwicklungsbranche ist Wissen Macht. Aber wie Sie dieses Wissen weitergeben, h\u00e4ngt von Ihrer Software-Dokumentation ab. <\/p>\n\n<p>Software-Dokumentation bezieht sich auf Handb\u00fccher, Anleitungen, Dokumente und Dokumentationsmaterial, die die Entwicklung, die Konnektivit\u00e4t, die F\u00e4higkeiten und die Verwendung eines Softwareprodukts beschreiben. Software-Dokumentation ist Teil jeder Software. Die Vorgehensweise bei der Software-Dokumentation ist f\u00fcr den Erfolg des Produkts entscheidend. Eine gute Softwaredokumentation muss ein interaktives Benutzererlebnis, eine Informationsarchitektur und ein gutes Verst\u00e4ndnis f\u00fcr Ihre Zielgruppe beinhalten. Sie muss dem Zweck dienen, Probleme zu l\u00f6sen, auf die der Entwickler oder der Endbenutzer st\u00f6\u00dft.    <\/p>\n\n<p>Als Softwareentwickler kommen Sie um das Schreiben von Dokumentation nicht herum. Das Schreiben von Software-Dokumentation ist eine Kunst, die als Technisches Schreiben bezeichnet wird. Wie das normale Schreiben ist auch dies eine Sache, die Sie \u00fcben und mit der Zeit besser werden k\u00f6nnen. Es gibt viele Arten von Software-Dokumentation, darunter:   <\/p>\n\n<ul class=\"wp-block-list\">\n<li>Anforderungen Dokumentation<\/li>\n\n\n\n<li>Architektur Design Dokumentation<\/li>\n\n\n\n<li>Benutzerdokumentation<\/li>\n\n\n\n<li>API-Dokumentation<\/li>\n\n\n\n<li>Dokumentation zur Qualit\u00e4tssicherung<\/li>\n<\/ul>\n\n<p><strong>HINWEIS: Es ist ratsam, die Dokumentation in Ihren Entwicklungsprozess einzubauen, wenn Sie versuchen, die agilen Methoden f\u00fcr die Softwareentwicklung anzuwenden.<\/strong><\/p>\n\n<p>Es ist ziemlich anspruchsvoll, eine Software-Dokumentation zu schreiben. Und damit Ihre Software erfolgreich ist, m\u00fcssen Sie eine detaillierte und verst\u00e4ndliche Darstellung von Informationen \u00fcber das Produkt enthalten. Der Prozess des Schreibens von Software-Dokumentation ist von Unternehmen zu Unternehmen unterschiedlich.  <\/p>\n\n<p>Hier finden Sie einige ideale Ans\u00e4tze, um sicherzustellen, dass der Prozess reibungslos abl\u00e4uft und ausgezeichnete Ergebnisse erzielt werden k\u00f6nnen, wenn Sie sich daran halten.<\/p>\n\n<p><strong>Verstehen Sie den Zweck des Dokuments<\/strong><\/p>\n\n<figure class=\"wp-block-image is-resized\"><img decoding=\"async\" src=\"https:\/\/lh5.googleusercontent.com\/B-v1xzLI8bEtN1cAqwEdpDBdpNRPUtmPWzhXXuk85FMBvqX6AMndIQ8jfbiowwddXR1xriQ0wysU_4egzu6XDlDfmna8SZUgNZhMGqgw3-t3VHVuQKprhhDLTEqmNArhvAhMBnmHGsK8I7StOJSxfhE\" alt=\"\" width=\"412\" height=\"232\"\/><\/figure>\n\n<p>Um eine ideale Softwaredokumentation zu erstellen, m\u00fcssen Sie einen Schritt zur\u00fccktreten und sich bewusst machen, warum Sie das Dokument erstellen. Beim Schreiben von Softwaredokumentation besteht das Hauptziel darin, das Leben sowohl der Benutzer als auch der Entwickler zu erleichtern. Selbst die besten technischen Redakteure k\u00f6nnen das Hauptziel dieser Dokumentation nicht erkennen, da es viele Ziele gibt. Aus diesem Grund m\u00fcssen Sie Ihre Aufmerksamkeit auf das Hauptziel Ihrer Dokumentation richten. Wenn Sie schreiben, um praktische Unterst\u00fctzung f\u00fcr den Endbenutzer zu leisten, muss das Dokument den Benutzern helfen zu verstehen, wie sie die Software einrichten und ihre Funktionen nutzen k\u00f6nnen. Das Dokument muss einfach und gut strukturiert sein, indem es alle Informationen, die der Benutzer ben\u00f6tigt, an einer Stelle zusammenfasst, so dass er nicht erst auf der Website nachschlagen muss, um zu verstehen, wie das Produkt funktioniert. Wenn Sie ein Dokument erstellen, um Produktinformationen bereitzustellen, dann muss das Dokument Details \u00fcber das Produkt enthalten. Das Dokument sollte zum Beispiel die wichtigsten Funktionen und deren Funktionsweise, die erforderlichen Hardware- und Softwareanforderungen, Kompatibilit\u00e4tsdetails, den Installationsprozess und alle anderen wichtigen Informationen enthalten.       <\/p>\n\n<p><strong>Aktionstipp: \u00d6ffnen Sie ein leeres Dokument und schreiben Sie den Zweck der Dokumentation Ihrer Software. Schreiben Sie Ihr Dokument also auf der Grundlage seines Zwecks. Geben Sie auch deutlich an, f\u00fcr wen dieses Dokument bestimmt ist. Erarbeiten Sie Pers\u00f6nlichkeiten, die Ihren Inhalt lesen m\u00fcssen.   <\/strong><\/p>\n\n<p><strong>Kennen Sie Ihr Zielpublikum<\/strong><\/p>\n\n<figure class=\"wp-block-image is-resized\"><img decoding=\"async\" src=\"https:\/\/lh4.googleusercontent.com\/ebzJ9eBcPGEwwH3khNBZHOjhRIabaJsQ5YeqkfIEBt5x-0QWWBGNsWc1NpcxJGXQGLacdYpKSfzHKWeDa-6BdCk4aYFve-go1MBM9H5JwFYu0pLCcbPaUwW-cc5x21uetIfRSTGz8qMY_bAJTJpy5U4\" alt=\"\" width=\"416\" height=\"277\"\/><\/figure>\n\n<p>Zun\u00e4chst m\u00fcssen Sie wissen, f\u00fcr wen Sie die Dokumentation schreiben. Wenn Sie Software-Dokumentation schreiben, schreiben Sie normalerweise f\u00fcr Software-Entwickler wie Sie selbst. Das ist ein Vorteil, denn so k\u00f6nnen Sie leichter erkennen, was f\u00fcr diese wichtig ist. Bei der Erstellung der Dokumentation gibt es keinen Mehrzweck. Deshalb m\u00fcssen Sie Ihr Publikum entsprechend bestimmen. Entwickler sind nicht die Leute, die nach kreativer Prosa suchen, sondern erwarten eine zusammenfassende Dokumentation, die alle ihre Fragen beantwortet. Wenn Sie f\u00fcr Endbenutzer schreiben. Das Ziel der Dokumentation ist es, die Informationen bereitzustellen, die die Bed\u00fcrfnisse des Lesers befriedigen, bevor er sich an den technischen Support wenden kann, um Hilfe bei der Fehlerbehebung zu erhalten. Daher m\u00fcssen Sie die Bed\u00fcrfnisse der Benutzer verstehen und sie von Beginn des Entwicklungsprozesses an ber\u00fccksichtigen. Die Dokumentation muss auf diese Bed\u00fcrfnisse eingehen und die notwendige Hilfe bieten. Wenn Sie f\u00fcr Endbenutzer schreiben, sind Sie wahrscheinlich weniger technisch und wortreicher, damit diese verstehen, was Sie schreiben. Dies k\u00f6nnen Sie erreichen, indem Sie Infografiken verwenden und auf Fachbegriffe verzichten oder diese erkl\u00e4ren.           <\/p>\n\n<p><strong>Aktionstipp: Ermitteln Sie anhand der praktischen Informationen mehrere Charaktere der Zielgruppe. Finden Sie die Ziele, Bed\u00fcrfnisse und Vorlieben der einzelnen Personen heraus. Auf diese Weise k\u00f6nnen Sie die richtigen Informationen f\u00fcr Ihr Publikum ermitteln.  <\/strong><\/p>\n\n<p><strong>API-Dokumentation<\/strong><\/p>\n\n<figure class=\"wp-block-image is-resized\"><img loading=\"lazy\" decoding=\"async\" src=\"https:\/\/lh4.googleusercontent.com\/OKFSoBjfG7mBwJW9FbpVS-6SgKHPhtlXesQFW_KNAbJHX-QAyj4ya4cvYiz1LzMNGEgNsLJvfZO2IosWYDqIgPi7_JDmQ9tl1rwMEBhpROM_Cg1f4DGYRezc4WP5kydqqRM6qrPYo5GW0mtxjFk56_I\" alt=\"\" width=\"434\" height=\"267\"\/><\/figure>\n\n<p>Die API-Dokumentation ist der technische Inhalt, der die API dokumentiert. Sie enth\u00e4lt Informationen dar\u00fcber, wie Sie die APIs effektiv nutzen und integrieren k\u00f6nnen. Die API-Dokumentation beschreibt einzelne Funktionen, Methoden und Komponenten Ihrer Bibliothek. Diese kurzen Erkl\u00e4rungen erl\u00e4utern den Zweck der Funktion, zeigen ihren Typ und ihre R\u00fcckgabe in Form eines Funktionskopfes. Dieser Header enth\u00e4lt in der Regel einen eingebetteten Link zur Funktionsdefinition im Quellcode. Die API-Dokumentation ist die einzige M\u00f6glichkeit, herauszufinden, wie Ihre Bibliothek funktioniert. Denken Sie beim Verfassen der API-Dokumentation daran, dass eine Funktion, Klasse oder Variable, die offengelegt wird, auch dokumentiert werden muss. Die Dokumentation muss eine zusammenfassende Beschreibung der Komponente enthalten und alle Extremf\u00e4lle aufzeigen, die auftreten k\u00f6nnen. Betrachten Sie die API-Dokumentation als ein Benutzerhandbuch mit allen Informationen, die Sie f\u00fcr die Arbeit mit der API ben\u00f6tigen.        <\/p>\n\n<p><strong>Aktionstipp: Suchen Sie zun\u00e4chst Ihre API und bearbeiten Sie dann die Beschreibung der API. Sie k\u00f6nnen Listen, Tabellen und externe Links einf\u00fcgen. <\/strong><\/p>\n\n<p><strong>Anpassung der agilen oder DevOps-Methodik f\u00fcr die Dokumentation<\/strong><\/p>\n\n<figure class=\"wp-block-image is-resized\"><img loading=\"lazy\" decoding=\"async\" src=\"https:\/\/lh5.googleusercontent.com\/irhQajX1fHI6sTTVkZfE8ylVhoDIn2T3EpyGSoWZw4zi0JDnF4-P8hDRmnuFhNYbOYF_mDfN2LEnobW_QzYsVnqkW9JbgJYZX9zXNNyx6Wvt7MyWuA462UZ2-zBCRmZQzgyQ7bzF_gHKB8ykD3H4zzc\" alt=\"\" width=\"412\" height=\"275\"\/><\/figure>\n\n<p>Der agile Ansatz ist nicht nur w\u00e4hrend des Softwareentwicklungsprozesses von Vorteil, sondern auch bei der Erstellung Ihrer Softwaredokumentation. Der agile Ansatz erlaubt es Ihnen nicht, Ihre gesamte Dokumentation so sp\u00e4t wie m\u00f6glich zu erstellen, sondern hilft Ihnen stattdessen dabei, die Dokumente dann zu erstellen, wenn Sie sie liefern m\u00fcssen. Dieser Ansatz hilft Ihnen, kontinuierlich zu dokumentieren. Sie schreiben Ihre Softwaredokumentation w\u00e4hrend des gesamten Projekts und aktualisieren sie, wenn Sie Ihren Code aktualisieren. Viele technische Redakteure verwenden Docs Like Code oder die Just In Time-Methode, beides Teilbereiche von Agile. Diese Methoden f\u00f6rdern die Zusammenarbeit zwischen den Beteiligten. Au\u00dferdem bieten sie Flexibilit\u00e4t bei der Versions- und Quellcodekontrolle.      <\/p>\n\n<p><strong>Aktions-Tipp: Schreiben Sie Ihre Dokumentation &#8222;Just in Time&#8220;. Warten Sie, bevor Sie dokumentieren &#8211; das ist der beste Weg, um zu vermeiden, dass Sie falsche und veraltete Informationen sammeln. Erstellen Sie die Dokumentation, wenn sie ben\u00f6tigt wird, nicht vorher.  <\/strong><\/p>\n\n<p><strong>Verwenden Sie visuelle Dokumentation<\/strong><\/p>\n\n<figure class=\"wp-block-image size-large is-resized\"><img loading=\"lazy\" decoding=\"async\" src=\"https:\/\/devologyx.io\/wp-content\/uploads\/2023\/07\/pexels-kindel-media-7688460-1024x768.jpg\" alt=\"\" class=\"wp-image-16899\" width=\"414\" height=\"311\" srcset=\"https:\/\/devologyx.io\/wp-content\/uploads\/2023\/07\/pexels-kindel-media-7688460-1024x768.jpg 1024w, https:\/\/devologyx.io\/wp-content\/uploads\/2023\/07\/pexels-kindel-media-7688460-300x225.jpg 300w, https:\/\/devologyx.io\/wp-content\/uploads\/2023\/07\/pexels-kindel-media-7688460-768x576.jpg 768w, https:\/\/devologyx.io\/wp-content\/uploads\/2023\/07\/pexels-kindel-media-7688460-1536x1152.jpg 1536w, https:\/\/devologyx.io\/wp-content\/uploads\/2023\/07\/pexels-kindel-media-7688460-2048x1536.jpg 2048w\" sizes=\"(max-width: 414px) 100vw, 414px\" \/><\/figure>\n\n<p>Bilder und Anleitungen sagen mehr als tausend Worte. Wenn Sie Ihre Dokumentation durch Bildmaterial erg\u00e4nzen, werden die L\u00e4nge und die Komplexit\u00e4t des Dokuments minimiert. Eine gute Dokumentation enth\u00e4lt in der Regel Fotos und Anleitungen zur Verwendung der Bibliothek f\u00fcr Anwendungsf\u00e4lle und zur Erledigung von Aufgaben mithilfe ihrer inneren Funktionen. Wenn Sie Bilder hinzuf\u00fcgen und Anleitungen f\u00fcr Ihre Dokumentation erstellen, denken Sie an alle Situationen, in denen Ihre Bibliothek verwendet wird. W\u00e4hlen Sie dann ein paar Anwendungsf\u00e4lle aus und erkl\u00e4ren Sie Ihren Benutzern, wie sie diese implementieren sollten. Sie k\u00f6nnen Ihre Grafiken einf\u00fcgen, w\u00e4hrend Sie das Dokument schreiben, falls verf\u00fcgbar. Diese Bilder und Anleitungen werden von technischen Redakteuren verwendet, um eine technische Idee hervorzuheben und zu vertiefen. Viele Bilder und Anleitungen sind kein Zeichen f\u00fcr eine gute Dokumentation. Es geht nicht um Quantit\u00e4t, sondern um Qualit\u00e4t.        <\/p>\n\n<p><strong>Aktions-Tipp: Wenn Sie Ihre Software-Dokumentation schreiben, w\u00e4hlen Sie einige technische Themen aus und f\u00fcgen Sie Anleitungen und Bilder hinzu, die erkl\u00e4ren, wie Sie diese Themen angehen k\u00f6nnen.<\/strong><\/p>\n\n<p><strong>Eine Gliederung erstellen<\/strong><\/p>\n\n<figure class=\"wp-block-image is-resized\"><img loading=\"lazy\" decoding=\"async\" src=\"https:\/\/lh3.googleusercontent.com\/38v34SeN-N5_g-g2Lcfge9jG_aPot06XWf2JvHNmtvi3EDVQEW2ywme5QeYIt4oe2MLlhirYZRo0Girz3zhfkKfb3bbW6GK8fMOhQyeNLfvJ_FLpZZUq4foGzDz0NAM_bAgfCqOE6f6mHDMFvt9UGe8\" alt=\"\" width=\"413\" height=\"459\"\/><\/figure>\n\n<p>Um eine Software-Dokumentation zu schreiben, m\u00fcssen Sie den Prozess der Gliederung verstehen. Der n\u00e4chste Schritt besteht darin, einen geeigneten Entwurf f\u00fcr Ihr Dokument zu erstellen. Wenn Sie ein bestimmtes Dokument zum ersten Mal schreiben, m\u00fcssen Sie bei Null anfangen. Wie bei allem anderen auch, k\u00f6nnen Sie nicht eine einzige Vorlage f\u00fcr alle Arten von Software-Dokumentation verwenden. Das Layout und die Struktur Ihrer Dokumentation h\u00e4ngen in der Regel von den genauen Zielen ab, die Sie erreichen m\u00f6chten, und vom Niveau Ihrer Zielgruppe.    <\/p>\n\n<p><strong>Aktionstipp: Recherchieren Sie und erstellen Sie einen Dokumentationsplan. Verwenden Sie zur Strukturierung und Gestaltung Ihres Dokuments Vorlagen f\u00fcr   <\/strong>ein <strong>einheitliches Design auf der Seite.<\/strong><\/p>\n\n<p><strong>Unterm Strich<\/strong><\/p>\n\n<p>Oben finden Sie einige der Ans\u00e4tze f\u00fcr eine perfekte Software-Dokumentation. Dazu geh\u00f6ren die Verwendung von Bildern, die Erstellung einer Gliederung und die Anpassung an die agile Methodik. Der Schl\u00fcssel zur Erstellung einer hochwertigen Softwaredokumentation ist eine sorgf\u00e4ltige Planung. Wie jede andere technische Arbeit sollte auch die Softwaredokumentation nie \u00fcberst\u00fcrzt werden. Au\u00dferdem ist sie nie ein Einzelprojekt. Softwareentwickler und andere Parteien, die direkt oder indirekt mit der Dokumentation zu tun haben, arbeiten zusammen, um sie fertig zu stellen.     <\/p>\n","protected":false},"excerpt":{"rendered":"<p>In der Softwareentwicklungsbranche ist Wissen Macht. Aber wie Sie dieses Wissen weitergeben, h\u00e4ngt von Ihrer Software-Dokumentation ab. Software-Dokumentation bezieht sich auf Handb\u00fccher, Anleitungen, Dokumente und Dokumentationsmaterial, die die Entwicklung, die Konnektivit\u00e4t, die F\u00e4higkeiten und die Verwendung eines Softwareprodukts beschreiben. Software-Dokumentation ist Teil jeder Software. Die Vorgehensweise bei der Software-Dokumentation ist f\u00fcr den Erfolg des Produkts [&hellip;]<\/p>\n","protected":false},"author":1,"featured_media":16905,"comment_status":"open","ping_status":"open","sticky":false,"template":"","format":"standard","meta":{"_themeisle_gutenberg_block_has_review":false,"_jet_sm_ready_style":"","_jet_sm_style":"","_jet_sm_controls_values":"","_jet_sm_fonts_collection":"","_jet_sm_fonts_links":"","footnotes":""},"categories":[20],"tags":[],"writer":[],"class_list":["post-19872","post","type-post","status-publish","format-standard","has-post-thumbnail","hentry","category-unkategorisiert"],"_links":{"self":[{"href":"https:\/\/devologyx.io\/de\/wp-json\/wp\/v2\/posts\/19872","targetHints":{"allow":["GET"]}}],"collection":[{"href":"https:\/\/devologyx.io\/de\/wp-json\/wp\/v2\/posts"}],"about":[{"href":"https:\/\/devologyx.io\/de\/wp-json\/wp\/v2\/types\/post"}],"author":[{"embeddable":true,"href":"https:\/\/devologyx.io\/de\/wp-json\/wp\/v2\/users\/1"}],"replies":[{"embeddable":true,"href":"https:\/\/devologyx.io\/de\/wp-json\/wp\/v2\/comments?post=19872"}],"version-history":[{"count":3,"href":"https:\/\/devologyx.io\/de\/wp-json\/wp\/v2\/posts\/19872\/revisions"}],"predecessor-version":[{"id":20077,"href":"https:\/\/devologyx.io\/de\/wp-json\/wp\/v2\/posts\/19872\/revisions\/20077"}],"wp:featuredmedia":[{"embeddable":true,"href":"https:\/\/devologyx.io\/de\/wp-json\/wp\/v2\/media\/16905"}],"wp:attachment":[{"href":"https:\/\/devologyx.io\/de\/wp-json\/wp\/v2\/media?parent=19872"}],"wp:term":[{"taxonomy":"category","embeddable":true,"href":"https:\/\/devologyx.io\/de\/wp-json\/wp\/v2\/categories?post=19872"},{"taxonomy":"post_tag","embeddable":true,"href":"https:\/\/devologyx.io\/de\/wp-json\/wp\/v2\/tags?post=19872"},{"taxonomy":"writer","embeddable":true,"href":"https:\/\/devologyx.io\/de\/wp-json\/wp\/v2\/writer?post=19872"}],"curies":[{"name":"wp","href":"https:\/\/api.w.org\/{rel}","templated":true}]}}