{"id":880810,"date":"2023-10-21T19:12:23","date_gmt":"2023-10-22T00:12:23","guid":{"rendered":"https:\/\/blogging-techies.com\/ge\/die-bedeutung-der-dokumentation-fur-webentwickler\/"},"modified":"2023-10-21T19:12:23","modified_gmt":"2023-10-22T00:12:23","slug":"die-bedeutung-der-dokumentation-fur-webentwickler","status":"publish","type":"post","link":"https:\/\/blogging-techies.com\/ge\/die-bedeutung-der-dokumentation-fur-webentwickler\/","title":{"rendered":"Die Bedeutung der Dokumentation f\u00fcr Webentwickler"},"content":{"rendered":"<p>Im Bereich der Entwicklung von Mobil-, Web- und Desktop-Anwendungen oder JavaScript-Bibliotheken spielt die Dokumentation eine wichtige Rolle f\u00fcr den Erfolg der Anwendung.  Aber wenn Sie jemals Dokumentation gemacht haben, werden Sie mir zustimmen, dass dies die unbeliebteste Sache ist, die Entwickler tun.<\/p>\n<p>Im Gegensatz zum Schreiben von Code (wozu sich Entwickler verpflichtet haben) sollte die Dokumentation f\u00fcr . leicht verdaulich sein.  Technisch gesehen m\u00fcssen wir eine Maschinensprache (Code) in eine f\u00fcr Menschen verst\u00e4ndliche Sprache \u00fcbersetzen, was schwieriger ist, als es scheint.<\/p>\n<p>Auch wenn es sehr m\u00fchsam sein kann, ist das Schreiben von Dokumentationen wichtig und kommt Ihren Benutzern, Ihren Kollegen und insbesondere Ihnen selbst zugute.<\/p>\n<h4>Eine gute Dokumentation hilft Benutzern<\/h4>\n<p>Dokumentation hilft dem Leser. <strong>verstehen, wie Code funktioniert<\/strong>, offensichtlich.  Viele Entwickler machen jedoch den Fehler, davon auszugehen, dass die Benutzer der Software kompetent sind.<\/p>\n<p>Daher ist die Dokumentation m\u00f6glicherweise sp\u00e4rlich und l\u00e4sst viele der wesentlichen Elemente aus, die sie von Anfang an h\u00e4tte enthalten sollen.  Wenn Sie die Sprache beherrschen, k\u00f6nnen Sie Dinge aus eigener Initiative herausfinden;  Wenn nicht, dann sind Sie verloren.<\/p>\n<p>Die f\u00fcr Benutzer bestimmte Dokumentation besteht in der Regel aus praktischer Anwendung oder \u201eHow to\u201c.  Die allgemeine Faustregel beim Erstellen von Dokumentationen f\u00fcr allgemeine Benutzer lautet: <strong>es sollte klar sein<\/strong>.  Es ist vorzuziehen, menschenfreundliche W\u00f6rter anstelle von Fachbegriffen oder Fachjargon zu verwenden.  Auch reale Anwendungsbeispiele w\u00fcrden uns sehr freuen.<\/p>\n<p>Ein gutes Layoutdesign w\u00fcrde Benutzern auch dabei helfen, jeden Abschnitt der Dokumentation zu lesen, ohne ihre Augen zu \u00fcberanstrengen.  Einige gute Beispiele (auch bekannt als meine Favoriten) dienen der Dokumentation <a rel=\"nofollow noopener\" target=\"_blank\" href=\"https:\/\/getbootstrap.com\/docs\/3.4\/css\/\">Ohr<\/a> Und <a rel=\"nofollow noopener\" target=\"_blank\" href=\"https:\/\/codex.wordpress.org\/First_Steps_With_WordPress\">WordPress<\/a>&#8216; \u201eErste Schritte mit WordPress\u201c.<\/p>\n<h4>Helfen Sie anderen Entwicklern<\/h4>\n<p>Jeder Entwickler hat seinen eigenen Codierungsstil.  Aber wenn es darum geht, im Team zu arbeiten, m\u00fcssen wir oft Codes mit anderen Kollegen teilen.  Es ist also unerl\u00e4sslich <strong>einen Konsens \u00fcber einen Standard haben<\/strong> um alle auf dem gleichen Stand zu halten.  Eine korrekt geschriebene Dokumentation w\u00e4re die Referenz, die das Team ben\u00f6tigt.<\/p>\n<p>Aber im Gegensatz zur Endbenutzerdokumentation beschreibt diese Dokumentation normalerweise <strong>technische Verfahren<\/strong> Zum Beispiel die Code-Namenskonvention, die zusammen mit Codebeispielen zeigt, wie bestimmte Seiten erstellt werden sollten und wie die API funktioniert.  Oftmals m\u00fcssten wir auch eine Dokumentation inline mit dem Code schreiben (sogenannte Dokumentation), um zu beschreiben, was der Code tut.<\/p>\n<p>Dar\u00fcber hinaus f\u00fcr den Fall, dass Sie haben <strong>neue Mitglieder beitreten<\/strong> Wenn Sie Ihr Team sp\u00e4ter schulen, k\u00f6nnte diese Dokumentation eine effektive M\u00f6glichkeit sein, es zu schulen, sodass Sie ihm keine individuelle Analyse des Codes geben m\u00fcssen.<\/p>\n<h4>Es hilft auch dem Encoder selbst.<\/h4>\n<p>Das Lustige am Codieren ist, dass es manchmal so ist <strong>Selbst die Entwickler selbst verstehen den Code, den sie geschrieben haben, nicht.<\/strong>.  Dies gilt insbesondere dann, wenn die Codes \u00fcber Monate oder sogar Jahre hinweg nicht ge\u00e4ndert wurden.<\/p>\n<p>Ein pl\u00f6tzliches Bed\u00fcrfnis, die Codes aus dem einen oder anderen Grund zu \u00fcberpr\u00fcfen, w\u00fcrde einen dazu bringen, sich zu fragen, was ihnen durch den Kopf ging, als sie diese Codes schrieben.  Seien Sie nicht \u00fcberrascht: Ich war schon einmal in dieser Situation. <strong>Dann habe ich meinen Code richtig dokumentiert.<\/strong>.<\/p>\n<p>Durch die Dokumentation Ihrer Codes kommen Sie schnell und ohne Frustration zum Ende Ihrer Codes und sparen so viel Zeit, die Sie f\u00fcr \u00c4nderungen aufwenden m\u00fcssen.<\/p>\n<h4>Was macht eine gute Dokumentation aus?<\/h4>\n<p>Es gibt mehrere Faktoren, die zur Erstellung einer guten Dokumentation beitragen.  Einige der wichtigsten sind die folgenden:<\/p>\n<h5>1. Gehen Sie niemals davon aus<\/h5>\n<p>Gehen Sie nicht davon aus, dass Ihre Benutzer sowohl wissen, was sie wissen, als auch was sie wissen wollen.  Es ist immer besser <strong>Von Anfang an beginnen<\/strong> unabh\u00e4ngig vom Kompetenzniveau der Benutzer.<\/p>\n<p>Wenn Sie beispielsweise ein jQuery-Plugin erstellt haben, k\u00f6nnen Sie sich davon inspirieren lassen <a href=\"https:\/\/kenwheeler.github.io\/slick\/\" rel=\"nofollow noopener\" target=\"_blank\">SlickJS<\/a>Die Dokumentation von.  Es zeigt, wie man den HTML-Code strukturiert, wo man CSS und JavaScript ablegt, wie man das jQuery-Plugin auf seiner grundlegendsten Ebene initialisiert und es zeigt sogar das vollst\u00e4ndige endg\u00fcltige Markup nach dem Hinzuf\u00fcgen all dieser Dinge, was eine Art Selbstverst\u00e4ndlichkeit ist. Klugschei\u00dfer.<\/p>\n<figure class=\"is-mega\" data-lazy=\"\"><\/figure>\n<p>Die Quintessenz ist, dass die Dokumentation mit dem Denkprozess eines Benutzers und nicht eines Entwicklers geschrieben wird.  Wenn Sie Ihre eigene Dokumentation auf diese Weise angehen, erhalten Sie eine bessere Perspektive bei der Organisation Ihres eigenen St\u00fccks.<\/p>\n<h5>2. Befolgen Sie den Standard<\/h5>\n<p>Durch das Hinzuf\u00fcgen einer Dokumentation, die zum Code passt, <strong>Verwenden Sie den erwarteten Sprachstandard<\/strong>.  Es ist immer eine gute Idee, jede Funktion, die Variablen sowie den von der Funktion zur\u00fcckgegebenen Wert zu beschreiben.  Nachfolgend finden Sie ein Beispiel f\u00fcr eine gute Online-Dokumentation f\u00fcr PHP.<\/p>\n<pre name=\"code\" class=\"javascript\">\r\n\/**\r\n * Adds custom classes to the array of body classes.\r\n *\r\n * @param array $classes Classes for the body element.\r\n * @return array\r\n *\/\r\nfunction body_classes( $classes ) {\r\n\t\/\/ Adds a class of group-blog to blogs with more than 1 published author.\r\n\tif ( is_multi_author() ) {\r\n\t\t$classes[] = 'group-blog';\r\n\t}\r\n\r\n\treturn $classes;\r\n}\r\nadd_filter( 'body_class', 'body_classes' );\r\n<\/pre>\n<p>Im Folgenden finden Sie einige Referenzen zur Formatierung der Dokumentation gem\u00e4\u00df Best Practices in PHP, JavaScript und CSS:<\/p>\n<p>Wenn Sie SublimeText verwenden, w\u00fcrde ich die Installation empfehlen <a rel=\"nofollow noopener\" target=\"_blank\" href=\"https:\/\/github.com\/spadgos\/sublime-jsdocs\">DocBlockr<\/a> Dadurch wird Ihr Code auf intelligente Weise mit der Online-Dokumentation vorab gef\u00fcllt.<\/p>\n<h5>3. Grafische Elemente<\/h5>\n<p>Verwenden Sie grafische Elemente, sie sprechen besser als Text.  Diese Medien sind insbesondere dann n\u00fctzlich, wenn Sie Software mit einer grafischen Oberfl\u00e4che erstellen.  Sie k\u00f6nnen Zeigeelemente wie Pfeile, Kreise usw. hinzuf\u00fcgen <strong>Alles, was Benutzern helfen kann, ohne R\u00e4tselraten herauszufinden, wohin sie gehen m\u00fcssen, um Schritte auszuf\u00fchren<\/strong>.<\/p>\n<p>Im Folgenden finden Sie ein Beispiel aus der Tower-App, von dem Sie sich inspirieren lassen k\u00f6nnen.  Sie erkl\u00e4ren effizient, wie die Versionskontrolle funktioniert, und zwar auf eine angenehme Art und Weise, die sie verst\u00e4ndlicher macht als die Verwendung von Klartext-Befehlszeilen.<\/p>\n<h5>4. Schnitt<\/h5>\n<p>Sie k\u00f6nnten erw\u00e4gen, einen Teil der Dokumentation in Listen und Tabellen mit Aufz\u00e4hlungszeichen aufzunehmen, da l\u00e4ngere Inhalte dadurch f\u00fcr Benutzer einfacher zu scannen und zu lesen sind.<\/p>\n<p>F\u00fcgen Sie ein Inhaltsverzeichnis hinzu und unterteilen Sie die Dokumentation in leicht verst\u00e4ndliche Abschnitte, sodass jeder Abschnitt f\u00fcr das, was als N\u00e4chstes kommt, relevant bleibt. <strong>Seien Sie kurz und einfach<\/strong>.  Nachfolgend finden Sie ein Beispiel f\u00fcr eine gut organisierte Dokumentation in <a rel=\"nofollow noopener\" target=\"_blank\" href=\"https:\/\/developers.facebook.com\/docs\/sharing\/ios\">Facebook<\/a>.  Das Inhaltsverzeichnis f\u00fchrt uns mit einem Klick dorthin, wo wir springen m\u00f6chten.<\/p>\n<figure class=\"is-mega\" data-lazy=\"\"><\/figure>\n<h5>5. \u00dcberpr\u00fcfen und aktualisieren<\/h5>\n<p>\u00dcberpr\u00fcfen Sie abschlie\u00dfend die Dokumentation auf Fehler und \u00fcberarbeiten Sie sie bei Bedarf oder wenn wesentliche \u00c4nderungen am Produkt, an der Software oder an der Bibliothek vorgenommen werden.  Ihre Dokumentation w\u00e4re f\u00fcr niemanden von Nutzen, wenn sie nicht zusammen mit Ihrem Produkt regelm\u00e4\u00dfig aktualisiert wird.<\/p>\n   ","protected":false},"excerpt":{"rendered":"<p>Im Bereich der Entwicklung von Mobil-, Web- und Desktop-Anwendungen oder JavaScript-Bibliotheken spielt die Dokumentation eine wichtige Rolle f\u00fcr den Erfolg der Anwendung. Aber wenn Sie jemals Dokumentation gemacht haben, werden Sie mir zustimmen, dass dies die unbeliebteste Sache ist, die Entwickler tun. Im Gegensatz zum Schreiben von Code (wozu sich Entwickler verpflichtet haben) sollte die [&hellip;]<\/p>\n","protected":false},"author":1,"featured_media":880811,"comment_status":"closed","ping_status":"closed","sticky":false,"template":"","format":"standard","meta":{"footnotes":"","fifu_image_url":"https:\/\/blogging-techies.com\/wp-content\/uploads\/2023\/06\/01-350x197-1.webp","fifu_image_alt":""},"categories":[7],"tags":[],"_links":{"self":[{"href":"https:\/\/blogging-techies.com\/ge\/wp-json\/wp\/v2\/posts\/880810"}],"collection":[{"href":"https:\/\/blogging-techies.com\/ge\/wp-json\/wp\/v2\/posts"}],"about":[{"href":"https:\/\/blogging-techies.com\/ge\/wp-json\/wp\/v2\/types\/post"}],"author":[{"embeddable":true,"href":"https:\/\/blogging-techies.com\/ge\/wp-json\/wp\/v2\/users\/1"}],"replies":[{"embeddable":true,"href":"https:\/\/blogging-techies.com\/ge\/wp-json\/wp\/v2\/comments?post=880810"}],"version-history":[{"count":0,"href":"https:\/\/blogging-techies.com\/ge\/wp-json\/wp\/v2\/posts\/880810\/revisions"}],"wp:featuredmedia":[{"embeddable":true,"href":"https:\/\/blogging-techies.com\/ge\/wp-json\/wp\/v2\/media\/880811"}],"wp:attachment":[{"href":"https:\/\/blogging-techies.com\/ge\/wp-json\/wp\/v2\/media?parent=880810"}],"wp:term":[{"taxonomy":"category","embeddable":true,"href":"https:\/\/blogging-techies.com\/ge\/wp-json\/wp\/v2\/categories?post=880810"},{"taxonomy":"post_tag","embeddable":true,"href":"https:\/\/blogging-techies.com\/ge\/wp-json\/wp\/v2\/tags?post=880810"}],"curies":[{"name":"wp","href":"https:\/\/api.w.org\/{rel}","templated":true}]}}