{"id":42119,"date":"2019-03-18T00:00:00","date_gmt":"2019-03-17T21:00:00","guid":{"rendered":"https:\/\/prohoster.info\/blog\/blog_prohoster\/polzovatelskaya-dokumentatsiya-chto-delaet-eyo-plohoj-i-kak-eto-ispravit"},"modified":"2020-02-18T13:44:55","modified_gmt":"2020-02-18T10:44:55","slug":"polzovatelskaya-dokumentatsiya-chto-delaet-eyo-plohoj-i-kak-eto-ispravit","status":"publish","type":"post","link":"https:\/\/prohoster.info\/de\/blog\/novosti-interneta\/polzovatelskaya-dokumentatsiya-chto-delaet-eyo-plohoj-i-kak-eto-ispravit","title":{"rendered":"Benutzerdokumentation: Was macht sie schlecht und wie kann man das beheben.","gt_translate_keys":[{"key":"rendered","format":"text"}]},"content":{"rendered":"<p><img decoding=\"async\" alt=\"Benutzerdokumentation: Was macht sie schlecht und wie kann man das beheben.\" src=\"\/wp-content\/uploads\/2019\/03\/4381d63e81fbb299384255cb54dd34b5.jpeg\" style=\"display:block;margin: 0 auto;\" \/><br \/>\n<br \/>\nDokumentation zu Software ist einfach eine Ansammlung von Artikeln. Aber selbst diese k\u00f6nnen frustrieren. Zuerst sucht man lange nach der richtigen Anleitung. Dann k\u00e4mpft man mit unverst\u00e4ndlichem Text. Man macht, was geschrieben steht, aber das Problem bleibt ungel\u00f6st. Man sucht nach einem anderen Artikel, wird nerv\u00f6s\u2026 Nach einer Stunde wirft man alles hin und geht. So funktioniert schlechte Dokumentation. Was sie so macht und wie man das \u00e4ndern kann \u2013 lesen Sie unten.<br \/>\n<noindex><a rel=\"nofollow\" name=\"habracut\"><\/a><\/noindex><\/p>\n<blockquote><p>In unserer alten Dokumentation gab es viele M\u00e4ngel. Seit fast einem Jahr \u00fcberarbeiten wir sie, um sicherzustellen, dass das oben beschriebene Szenario unsere Kunden nicht betrifft. Sehen Sie sich an, <noindex><a rel=\"nofollow\" href=\"https:\/\/doc.ispsystem.ru\/index.php\/\">wie es war<\/a><\/noindex> und <noindex><a rel=\"nofollow\" href=\"https:\/\/docs.ispsystem.ru\/\">wie es jetzt ist<\/a><\/noindex>.<\/p><\/blockquote>\n<p><\/p>\n<h2>Problem 1. Unklare, schlecht geschriebene Artikel<\/h2>\n<p>\nWenn man in der Dokumentation nicht klar kommt, was hat sie dann f\u00fcr einen Sinn? Aber niemand schreibt absichtlich unklare Artikel. Diese entstehen, wenn der Autor nicht an das Publikum und das Ziel denkt, unn\u00f6tiges Gerede ausbreitet und den Text nicht auf Fehler \u00fcberpr\u00fcft.<\/p>\n<ul>\n<li><b>Das Publikum<\/b>. Vor dem Schreiben eines Artikels sollte man \u00fcber das Wissensniveau des Lesers nachdenken. Es ist logisch, dass in einem Artikel f\u00fcr Anf\u00e4nger die grundlegenden Schritte nicht ausgelassen und technische Begriffe ohne Erl\u00e4uterung stehen gelassen werden sollten, w\u00e4hrend in einem Artikel \u00fcber eine seltene Funktion, die nur f\u00fcr Profis relevant ist, die Bedeutung des Begriffs PHP erkl\u00e4rt werden sollte.<\/li>\n<li><b>Ziel<\/b>. Eine weitere Sache, \u00fcber die man im Voraus nachdenken sollte. Der Autor sollte ein klares Ziel setzen, die n\u00fctzliche Handlung des Artikels definieren und entscheiden, was der Leser nach dem Lesen tun wird. Andernfalls entsteht eine Beschreibung nur um der Beschreibung willen. <\/li>\n<li><b>Wasser und Fehler<\/b>. Zu viele \u00fcberfl\u00fcssige Informationen und B\u00fcrokratismen, Fehler und Tippfehler st\u00f6ren das Verst\u00e4ndnis. Selbst wenn der Leser kein Grammatik-Nazi ist, kann Nachl\u00e4ssigkeit im Text ihn abschrecken.<\/li>\n<\/ul>\n<p>\nBer\u00fccksichtigen Sie die oben genannten Tipps, und die Artikel werden garantiert verst\u00e4ndlicher. Um es noch besser zu machen, nehmen Sie unsere <noindex><a rel=\"nofollow\" href=\"https:\/\/habr.com\/ru\/company\/ispsystem\/blog\/431456\/\"> 50 Fragen zur Erstellung technischer Dokumentationen zur Hand<\/a><\/noindex>.<\/p>\n<h2>Problem 2. Artikel beantworten nicht alle Fragen<\/h2>\n<p>\nEs ist schlecht, wenn die Dokumentation mit der Entwicklung nicht Schritt h\u00e4lt, reale Fragen nicht beantwortet werden und Fehler \u00fcber Jahre hinweg nicht korrigiert werden. Das sind weniger Probleme des Autors, sondern vielmehr der Organisation der Prozesse innerhalb des Unternehmens.<\/p>\n<h3>Die Dokumentation h\u00e4lt nicht mit der Entwicklung Schritt<\/h3>\n<p>\nDas Feature ist bereits ver\u00f6ffentlicht, das Marketing plant, es zu bewerben, und nun stellt sich heraus, dass es noch keinen Artikel oder \u00dcbersetzung in der Dokumentation gibt. Das hat uns sogar gezwungen, die Ver\u00f6ffentlichung zu verschieben. Man kann so oft wie n\u00f6tig alle auffordern, die Aufgaben rechtzeitig an die technischen Redakteure weiterzuleiten, aber das wird nicht funktionieren. Wenn der Prozess nicht automatisiert wird, wird sich die Situation wiederholen.<\/p>\n<p>Wir haben \u00c4nderungen in YouTrack vorgenommen. Die Aufgabe zum Schreiben eines Artikels \u00fcber das neue Feature f\u00e4llt gleichzeitig mit dem Beginn der Tests an einen technischen Redakteur. Auch das Marketing erf\u00e4hrt dann davon, um sich auf die Promotion vorzubereiten. Die Benachrichtigungen kommen zudem in den Unternehmensmessenger Mattermost, sodass es unm\u00f6glich ist, Neuigkeiten von den Entwicklern zu verpassen.<\/p>\n<h3>Die Dokumentation spiegelt nicht die Anfragen der Nutzer wider.<\/h3>\n<p>\nWir sind es gewohnt, so zu arbeiten: Ein Feature wird ver\u00f6ffentlicht, und wir berichten dar\u00fcber. Wir beschreiben, wie man es ein- und ausschaltet sowie feine Anpassungen vornimmt. Aber was ist, wenn der Kunde unsere Software anders anwendet, als wir angenommen haben? Oder wenn Fehler auftreten, an die wir nicht gedacht haben?<\/p>\n<p>Um die Dokumentation so vollst\u00e4ndig wie m\u00f6glich zu gestalten, empfehlen wir die Analyse von Support-Anfragen, Fragen in themenspezifischen Foren und Suchanfragen. Die popul\u00e4rsten Themen sollten an technische Autoren weitergeleitet werden, damit sie bestehende Artikel erg\u00e4nzen oder neue schreiben.<\/p>\n<h3>Die Dokumentation wird nicht verbessert<\/h3>\n<p>\nEs ist schwierig, sofort etwas Perfektes zu schaffen, Fehler werden immer auftreten. Man kann auf Feedback von Kunden hoffen, aber es ist unwahrscheinlich, dass sie \u00fcber jeden Tippfehler, Ungenauigkeiten oder unklare bzw. nicht gefundene Artikel berichten. Neben den Kunden lesen auch Mitarbeiter die Dokumentation, das hei\u00dft, sie sehen die gleichen Fehler. Das kann genutzt werden! Es m\u00fcssen nur Bedingungen geschaffen werden, unter denen es einfach ist, ein Problem zu melden.<\/p>\n<p>Wir haben eine Gruppe im internen Portal, in der Mitarbeiter Anmerkungen, Vorschl\u00e4ge und Ideen zur Dokumentation hinterlassen. Braucht der Support einen Artikel, der nicht existiert? Hat der Tester eine Ungenauigkeit bemerkt? Hat ein Partner den Entwicklungsmanagern Fehler gemeldet? All dies geh\u00f6rt in diese Gruppe! Technische Redakteure korrigieren sofort manche Dinge, \u00fcbertragen andere in YouTrack und nehmen einige zur \u00dcberlegung mit. Damit das Thema nicht verstummt, erinnern wir von Zeit zu Zeit an die Existenz der Gruppe und die Wichtigkeit des Feedbacks.<\/p>\n<h2>Problem 3. Der gesuchte Artikel ist schwer zu finden.<\/h2>\n<p>\nEin Artikel, der nicht gefunden werden kann, ist nicht besser als ein nicht existierender Artikel. Das Motto guter Dokumentation sollte lauten: \u201eEinfach suchen, einfach finden\u201c. Wie erreicht man das?<\/p>\n<p><b>Die Struktur ordnen und das Kriterium f\u00fcr die Themenauswahl festlegen.<\/b>Die Struktur muss so transparent wie m\u00f6glich sein, damit der Leser sich nicht fragt: \"Wo finde ich diesen Artikel?\" Zusammenfassend gibt es zwei Ans\u00e4tze: von der Benutzeroberfl\u00e4che und von den Aufgaben.<\/p>\n<ol>\n<li>Von der Benutzeroberfl\u00e4che. Der Inhalt spiegelt die Abschnitte des Panels wider. So war es in der alten Dokumentation von ISPsystem.<\/li>\n<li>Aufgaben. Die Titel von Artikeln und Abschnitten spiegeln die Anliegen der Benutzer wider; in den \u00dcberschriften gibt es fast immer Verben und Antworten auf die Frage \u201eWie macht man es?\u201c. Jetzt wechseln wir zu diesem Format.<\/li>\n<\/ol>\n<p>\nEgal, welchen Ansatz Sie w\u00e4hlen, stellen Sie sicher, dass das Thema den Benutzeranfragen entspricht und so behandelt wird, dass der Benutzer seine Fragen eindeutig beantworten kann.<\/p>\n<p><b>Zentralisierte Suche einrichten<\/b>. In einer idealen Welt sollte die Suche auch dann funktionieren, wenn man sich vertippt oder mit der Sprache einen Fehler macht. Unsere Suche in Confluence kann das derzeit noch nicht bieten. Wenn Sie viele Produkte haben und die Dokumentation allgemein ist, passen Sie die Suche an die Seite an, auf der sich der Benutzer befindet. In unserem Fall funktioniert die Suche auf der Hauptseite f\u00fcr alle Produkte, w\u00e4hrend sie in einem bestimmten Abschnitt nur f\u00fcr die Artikel in diesem Abschnitt funktioniert.<\/p>\n<p><b>Inhaltsverzeichnis und \u201eBreadcrumbs\u201c hinzuf\u00fcgen<\/b>. Es ist vorteilhaft, wenn jede Seite ein Men\u00fc und Breadcrumbs hat \u2013 der Weg des Benutzers zur aktuellen Seite mit der M\u00f6glichkeit, auf jede Ebene zur\u00fcckzukehren. In der alten ISPsystem-Dokumentation musste man den Artikel verlassen, um zum Inhaltsverzeichnis zu gelangen. Das war unpraktisch, daher haben wir das in der neuen Version ge\u00e4ndert.<\/p>\n<p><b>Links im Produkt anordnen<\/b>. Wenn Menschen immer wieder mit der gleichen Frage den Support kontaktieren, ist es sinnvoll, einen Hinweis mit der L\u00f6sung im Interface hinzuzuf\u00fcgen. Wenn Sie Daten oder ein Verst\u00e4ndnis daf\u00fcr haben, wann der Benutzer auf ein Problem st\u00f6\u00dft, k\u00f6nnen Sie ihn auch per Newsletter informieren. So zeigen Sie F\u00fcrsorge und entlasten den Support.<\/p>\n<p><img decoding=\"async\" alt=\"Benutzerdokumentation: Was macht sie schlecht und wie kann man das beheben.\" src=\"\/wp-content\/uploads\/2019\/03\/ddf030647cf3271e0e34924ff5c8116f.jpeg\" style=\"display:block;margin: 0 auto;\" \/><br \/>\n<i>Auf der rechten Seite im Popup-Fenster befindet sich ein Link zu dem Artikel \u00fcber die Einstellung von DNSSEC im Abschnitt zur Verwaltung von Domains in ISPmanager.<\/i><\/p>\n<p><b>Cross-Links innerhalb der Dokumentation einrichten.<\/b>. Artikel, die miteinander verbunden sind, sollten \"verlinkt\" werden. Wenn Artikel eine Reihenfolge darstellen, f\u00fcgen Sie am Ende jedes Textes unbedingt Vorw\u00e4rts- und R\u00fcckw\u00e4rtspfeile hinzu.<\/p>\n<blockquote><p>Wahrscheinlich wird jemand zuerst die Antwort auf seine Frage nicht bei Ihnen, sondern in einer Suchmaschine suchen. Es w\u00e4re \u00e4rgerlich, wenn aus technischen Gr\u00fcnden keine Links zur Dokumentation vorhanden sind. Achten Sie also auf Suchmaschinenoptimierung.<\/p><\/blockquote>\n<p><\/p>\n<h2>Problem 4. Veraltete Layouts beeintr\u00e4chtigen das Verst\u00e4ndnis.<\/h2>\n<p>\nNeben schlechten Texten kann das Design die Dokumentation verderben. Menschen sind es gewohnt, gut gestaltete Materialien zu lesen. Blogs, soziale Medien, und andere Inhalte werden nicht nur sch\u00f6n, sondern auch lesefreundlich und angenehm f\u00fcr die Augen pr\u00e4sentiert. Daher ist es leicht nachzuvollziehen, welchen Schmerz jemand empfindet, der einen Text sieht, wie im Screenshot unten. <\/p>\n<p><noindex><a rel=\"nofollow\" href=\"https:\/\/hsto.org\/webt\/en\/8-\/3q\/en8-3qj_jpwfiie91efwo_igqtk.png\"><img decoding=\"async\" alt=\"Benutzerdokumentation: Was macht sie schlecht und wie kann man das beheben.\" src=\"\/wp-content\/uploads\/2019\/03\/0a0762670770950d062e1cd4c0f33f1d.jpeg\" style=\"display:block;margin: 0 auto;\" \/><\/a><\/noindex><br \/>\n<i>In diesem Artikel gibt es so viele Screenshots und Hervorhebungen, dass sie nicht hilfreich sind, sondern nur die Wahrnehmung st\u00f6ren (Bild ist anklickbar).<\/i><\/p>\n<p>Man sollte aus der Dokumentation keinen Longread mit vielen Effekten machen, aber grundlegende Regeln m\u00fcssen ber\u00fccksichtigt werden. <\/p>\n<p><b>Gestaltung<\/b>. Bestimmen Sie die Breite des Haupttextes, die Schriftart, die Gr\u00f6\u00dfe, die \u00dcberschriften und die Abst\u00e4nde. Ziehen Sie einen Designer hinzu, und um die Arbeit zu akzeptieren oder es selbst zu erledigen, lesen Sie das Buch von Artem Gorbunov \u00abTypografie und Gestaltung\u00bb. Es bietet nur einen Ansatz zur Gestaltung, aber dieser ist v\u00f6llig ausreichend.<\/p>\n<p><b>Hervorhebungen<\/b>. Bestimmen Sie, welche Textstellen hervorgehoben werden m\u00fcssen. Dies betrifft in der Regel Wege im Interface, Schaltfl\u00e4chen, Codeeinf\u00fcgungen, Konfigurationsdateien und Hinweise. Legen Sie fest, wie diese Elemente hervorgehoben werden sollen, und halten Sie dies in den Richtlinien fest. Bedenken Sie, dass weniger Hervorhebungen besser sind. Wenn es zu viele gibt, wird der Text \"laut\". Auch Anf\u00fchrungszeichen k\u00f6nnen ein Ger\u00e4usch erzeugen, wenn sie zu h\u00e4ufig verwendet werden.<\/p>\n<p><b>Screenshots<\/b>. Kl\u00e4ren Sie mit dem Team, in welchen F\u00e4llen Screenshots erforderlich sind. Es ist nicht notwendig, jeden Schritt zu illustrieren. Eine gro\u00dfe Anzahl von Screenshots, einschlie\u00dflich einzelner Schaltfl\u00e4chen, beeintr\u00e4chtigt das Verst\u00e4ndnis und st\u00f6rt das Layout. Bestimmen Sie Gr\u00f6\u00dfe und Format der Hervorhebungen sowie der Beschriftungen auf den Screenshots, und halten Sie dies in den Richtlinien fest. Denken Sie daran, dass Illustrationen immer dem Geschriebenen entsprechen und aktuell sein sollten. Nochmals, wenn das Produkt regelm\u00e4\u00dfig aktualisiert wird, wird es schwierig sein, alles im Auge zu behalten.<\/p>\n<p><b>L\u00e4nge des Textes<\/b>. Vermeiden Sie \u00fcberm\u00e4\u00dfig lange Artikel. Teilen Sie sie in Abschnitte auf, und wenn das nicht m\u00f6glich ist, f\u00fcgen Sie am Anfang des Artikels ein Inhaltsverzeichnis mit Ankerlinks hinzu. Eine einfache M\u00f6glichkeit, einen Artikel visuell k\u00fcrzer zu gestalten, besteht darin, technische Details, die nur f\u00fcr einen kleinen Leserkreis von Interesse sind, unter einem Spoiler zu verstecken.<\/p>\n<p><b>Formate<\/b>. Kombinieren Sie in den Artikeln mehrere Formate: Text, Video und Bilder. Das verbessert das Verst\u00e4ndnis. <\/p>\n<blockquote><p>Versuchen Sie nicht, Probleme mit einer ansprechenden Gestaltung zu verbergen. Ehrlich gesagt, wir haben selbst gehofft, dass die 'H\u00fclle' die veraltete Dokumentation retten w\u00fcrde \u2013 das hat nicht geklappt. In den Texten gab es so viel visuelles Rauschen und \u00fcberfl\u00fcssige Details, dass die Richtlinien und das neue Design machtlos waren.<\/p><\/blockquote>\n<p>\nVieles von dem, was oben beschrieben wurde, h\u00e4ngt von der Plattform ab, die Sie f\u00fcr die Dokumentation verwenden. Bei uns ist das zum Beispiel Confluence. Auch damit mussten wir viel arbeiten. Wenn es Sie interessiert, lesen Sie die Erz\u00e4hlung unseres Webentwicklers: <noindex><a rel=\"nofollow\" href=\"https:\/\/habr.com\/ru\/company\/ispsystem\/blog\/438236\/\">Confluence f\u00fcr eine \u00f6ffentliche Wissensdatenbank: Design\u00e4nderung und Anpassung der Sprachtrennung<\/a><\/noindex>.<\/p>\n<h2>Wie man mit Verbesserungen beginnt und \u00fcberlebt<\/h2>\n<p>\nWenn Ihre Dokumentation so umfangreich ist wie die von ISPsystem und Sie nicht wissen, wo Sie anfangen sollen, beginnen Sie mit den dringendsten Problemen. Kunden verstehen die Dokumentation nicht \u2013 verbessern Sie die Texte, erstellen Sie Richtlinien, schulen Sie die Autoren. Die Dokumentation ist veraltet \u2013 arbeiten Sie an den internen Prozessen. Beginnen Sie mit den beliebtesten Artikeln \u00fcber die meistgefragten Produkte: Fragen Sie den Support, schauen Sie sich die Website-Analyse und Suchanfragen an. <\/p>\n<p>Um es gleich vorweg zu sagen \u2013 es wird nicht einfach. Und schnell wird es wahrscheinlich auch nicht gehen. Es sei denn, Sie fangen gerade an und machen gleich alles richtig. Eines wissen wir mit Sicherheit \u2013 mit der Zeit wird es besser. Aber der Prozess wird niemals enden :-).<\/p>\n<p>Quelle: <a content=\"nofollow\" rel=\"nofollow\" href=\"https:\/\/habr.com\/ru\/company\/ispsystem\/blog\/443648\/\">habr.com<\/a><\/p>","protected":false,"gt_translate_keys":[{"key":"rendered","format":"html"}]},"excerpt":{"rendered":"<p>\u0414\u043e\u043a\u0443\u043c\u0435\u043d\u0442\u0430\u0446\u0438\u044f \u043a \u0441\u043e\u0444\u0442\u0443 \u2014 \u044d\u0442\u043e \u043f\u0440\u043e\u0441\u0442\u043e \u043d\u0430\u0431\u043e\u0440 \u0441\u0442\u0430\u0442\u0435\u0439. \u041d\u043e \u0434\u0430\u0436\u0435 \u043e\u043d\u0438 \u043c\u043e\u0433\u0443\u0442 \u0432\u044b\u0432\u0435\u0441\u0442\u0438 \u0438\u0437 \u0441\u0435\u0431\u044f. \u0421\u043d\u0430\u0447\u0430\u043b\u0430 \u0434\u043e\u043b\u0433\u043e \u0438\u0449\u0435\u0448\u044c \u043d\u0443\u0436\u043d\u0443\u044e \u0438\u043d\u0441\u0442\u0440\u0443\u043a\u0446\u0438\u044e. \u041f\u043e\u0442\u043e\u043c \u0440\u0430\u0437\u0431\u0438\u0440\u0430\u0435\u0448\u044c\u0441\u044f \u0432 \u043c\u0430\u043b\u043e\u043f\u043e\u043d\u044f\u0442\u043d\u043e\u043c \u0442\u0435\u043a\u0441\u0442\u0435. \u0414\u0435\u043b\u0430\u0435\u0448\u044c \u043a\u0430\u043a \u043d\u0430\u043f\u0438\u0441\u0430\u043d\u043e, \u0430 \u043f\u0440\u043e\u0431\u043b\u0435\u043c\u0430 \u043d\u0435 \u0440\u0435\u0448\u0430\u0435\u0442\u0441\u044f. \u0418\u0449\u0435\u0448\u044c \u0434\u0440\u0443\u0433\u0443\u044e \u0441\u0442\u0430\u0442\u044c\u044e, \u043d\u0435\u0440\u0432\u043d\u0438\u0447\u0430\u0435\u0448\u044c\u2026 \u0427\u0435\u0440\u0435\u0437 \u0447\u0430\u0441 \u043f\u043b\u044e\u0451\u0448\u044c \u043d\u0430 \u0432\u0441\u0451 \u0438 \u0443\u0445\u043e\u0434\u0438\u0448\u044c. \u0422\u0430\u043a \u0440\u0430\u0431\u043e\u0442\u0430\u0435\u0442 \u043f\u043b\u043e\u0445\u0430\u044f \u0434\u043e\u043a\u0443\u043c\u0435\u043d\u0442\u0430\u0446\u0438\u044f. \u0427\u0442\u043e \u0434\u0435\u043b\u0430\u0435\u0442 \u0435\u0451 \u0442\u0430\u043a\u043e\u0439, \u0438 \u043a\u0430\u043a \u044d\u0442\u043e \u0438\u0441\u043f\u0440\u0430\u0432\u0438\u0442\u044c [&hellip;]<\/p>\n","protected":false,"gt_translate_keys":[{"key":"rendered","format":"html"}]},"author":1,"featured_media":0,"comment_status":"open","ping_status":"open","sticky":false,"template":"","format":"standard","meta":{"footnotes":""},"categories":[702],"tags":[],"class_list":["post-42119","post","type-post","status-publish","format-standard","hentry","category-novosti-interneta"],"aioseo_notices":[],"aioseo_head":"\n\t\t<!-- All in One SEO 4.9.10 - aioseo.com -->\n\t<meta name=\"description\" content=\"\u0414\u043e\u043a\u0443\u043c\u0435\u043d\u0442\u0430\u0446\u0438\u044f \u043a \u0441\u043e\u0444\u0442\u0443 \u2014 \u044d\u0442\u043e \u043f\u0440\u043e\u0441\u0442\u043e \u043d\u0430\u0431\u043e\u0440 \u0441\u0442\u0430\u0442\u0435\u0439. \u041d\u043e \u0434\u0430\u0436\u0435 \u043e\u043d\u0438 \u043c\u043e\u0433\u0443\u0442 \u0432\u044b\u0432\u0435\u0441\u0442\u0438 \u0438\u0437 \u0441\u0435\u0431\u044f. \u0421\u043d\u0430\u0447\u0430\u043b\u0430 \u0434\u043e\u043b\u0433\u043e \u0438\u0449\u0435\u0448\u044c \u043d\u0443\u0436\u043d\u0443\u044e \u0438\u043d\u0441\u0442\u0440\u0443\u043a\u0446\u0438\u044e. \u041f\u043e\u0442\u043e\u043c \u0440\u0430\u0437\u0431\u0438\u0440\u0430\u0435\u0448\u044c\u0441\u044f \u0432 \u043c\u0430\u043b\u043e\u043f\u043e\u043d\u044f\u0442\u043d\u043e\u043c \u0442\u0435\u043a\u0441\u0442\u0435. \u0414\u0435\u043b\u0430\u0435\u0448\u044c \u043a\u0430\u043a \u043d\u0430\u043f\u0438\u0441\u0430\u043d\u043e, \u0430 \u043f\u0440\u043e\u0431\u043b\u0435\u043c\u0430 \u043d\u0435 \u0440\u0435\u0448\u0430\u0435\u0442\u0441\u044f. \u0418\u0449\u0435\u0448\u044c \u0434\u0440\u0443\u0433\u0443\u044e \u0441\u0442\u0430\u0442\u044c\u044e, \u043d\u0435\u0440\u0432\u043d\u0438\u0447\u0430\u0435\u0448\u044c\u2026 \u0427\u0435\u0440\u0435\u0437 \u0447\u0430\u0441 \u043f\u043b\u044e\u0451\u0448\u044c \u043d\u0430 \u0432\u0441\u0451 \u0438 \u0443\u0445\u043e\u0434\u0438\u0448\u044c. \u0422\u0430\u043a \u0440\u0430\u0431\u043e\u0442\u0430\u0435\u0442 \u043f\u043b\u043e\u0445\u0430\u044f \u0434\u043e\u043a\u0443\u043c\u0435\u043d\u0442\u0430\u0446\u0438\u044f. \u0427\u0442\u043e \u0434\u0435\u043b\u0430\u0435\u0442 \u0435\u0451 \u0442\u0430\u043a\u043e\u0439, \u0438 \u043a\u0430\u043a \u044d\u0442\u043e \u0438\u0441\u043f\u0440\u0430\u0432\u0438\u0442\u044c\" \/>\n\t<meta name=\"robots\" content=\"max-image-preview:large\" \/>\n\t<meta name=\"author\" content=\"Yuri Gagarin\"\/>\n\t<link rel=\"canonical\" href=\"https:\/\/prohoster.info\/de\/blog\/novosti-interneta\/polzovatelskaya-dokumentatsiya-chto-delaet-eyo-plohoj-i-kak-eto-ispravit\" \/>\n\t<meta name=\"generator\" content=\"All in One SEO (AIOSEO) 4.9.10\" \/>\n\t\t<meta property=\"og:locale\" content=\"de_DE\" \/>\n\t\t<meta property=\"og:site_name\" content=\"ProHoster | \u041a\u0443\u043f\u0438\u0442\u044c \u043d\u0430\u0434\u0435\u0436\u043d\u044b\u0439 \u0445\u043e\u0441\u0442\u0438\u043d\u0433 \u0434\u043b\u044f \u0441\u0430\u0439\u0442\u043e\u0432 \u0441 \u0437\u0430\u0449\u0438\u0442\u043e\u0439 \u043e\u0442 DDoS, VPS VDS \u0441\u0435\u0440\u0432\u0435\u0440\u044b\" \/>\n\t\t<meta property=\"og:type\" content=\"article\" \/>\n\t\t<meta property=\"og:title\" content=\"\ud83e\udd47\u041f\u043e\u043b\u044c\u0437\u043e\u0432\u0430\u0442\u0435\u043b\u044c\u0441\u043a\u0430\u044f \u0434\u043e\u043a\u0443\u043c\u0435\u043d\u0442\u0430\u0446\u0438\u044f: \u0447\u0442\u043e \u0434\u0435\u043b\u0430\u0435\u0442 \u0435\u0451 \u043f\u043b\u043e\u0445\u043e\u0439, \u0438 \u043a\u0430\u043a \u044d\u0442\u043e \u0438\u0441\u043f\u0440\u0430\u0432\u0438\u0442\u044c | ProHoster\" \/>\n\t\t<meta property=\"og:description\" content=\"\u0414\u043e\u043a\u0443\u043c\u0435\u043d\u0442\u0430\u0446\u0438\u044f \u043a \u0441\u043e\u0444\u0442\u0443 \u2014 \u044d\u0442\u043e \u043f\u0440\u043e\u0441\u0442\u043e \u043d\u0430\u0431\u043e\u0440 \u0441\u0442\u0430\u0442\u0435\u0439. \u041d\u043e \u0434\u0430\u0436\u0435 \u043e\u043d\u0438 \u043c\u043e\u0433\u0443\u0442 \u0432\u044b\u0432\u0435\u0441\u0442\u0438 \u0438\u0437 \u0441\u0435\u0431\u044f. \u0421\u043d\u0430\u0447\u0430\u043b\u0430 \u0434\u043e\u043b\u0433\u043e \u0438\u0449\u0435\u0448\u044c \u043d\u0443\u0436\u043d\u0443\u044e \u0438\u043d\u0441\u0442\u0440\u0443\u043a\u0446\u0438\u044e. \u041f\u043e\u0442\u043e\u043c \u0440\u0430\u0437\u0431\u0438\u0440\u0430\u0435\u0448\u044c\u0441\u044f \u0432 \u043c\u0430\u043b\u043e\u043f\u043e\u043d\u044f\u0442\u043d\u043e\u043c \u0442\u0435\u043a\u0441\u0442\u0435. \u0414\u0435\u043b\u0430\u0435\u0448\u044c \u043a\u0430\u043a \u043d\u0430\u043f\u0438\u0441\u0430\u043d\u043e, \u0430 \u043f\u0440\u043e\u0431\u043b\u0435\u043c\u0430 \u043d\u0435 \u0440\u0435\u0448\u0430\u0435\u0442\u0441\u044f. \u0418\u0449\u0435\u0448\u044c \u0434\u0440\u0443\u0433\u0443\u044e \u0441\u0442\u0430\u0442\u044c\u044e, \u043d\u0435\u0440\u0432\u043d\u0438\u0447\u0430\u0435\u0448\u044c\u2026 \u0427\u0435\u0440\u0435\u0437 \u0447\u0430\u0441 \u043f\u043b\u044e\u0451\u0448\u044c \u043d\u0430 \u0432\u0441\u0451 \u0438 \u0443\u0445\u043e\u0434\u0438\u0448\u044c. \u0422\u0430\u043a \u0440\u0430\u0431\u043e\u0442\u0430\u0435\u0442 \u043f\u043b\u043e\u0445\u0430\u044f \u0434\u043e\u043a\u0443\u043c\u0435\u043d\u0442\u0430\u0446\u0438\u044f. \u0427\u0442\u043e \u0434\u0435\u043b\u0430\u0435\u0442 \u0435\u0451 \u0442\u0430\u043a\u043e\u0439, \u0438 \u043a\u0430\u043a \u044d\u0442\u043e \u0438\u0441\u043f\u0440\u0430\u0432\u0438\u0442\u044c\" \/>\n\t\t<meta property=\"og:url\" content=\"https:\/\/prohoster.info\/de\/blog\/novosti-interneta\/polzovatelskaya-dokumentatsiya-chto-delaet-eyo-plohoj-i-kak-eto-ispravit\" \/>\n\t\t<meta property=\"og:image\" content=\"https:\/\/prohoster.info\/wp-content\/uploads\/2021\/11\/logo-350.jpg\" \/>\n\t\t<meta property=\"og:image:secure_url\" content=\"https:\/\/prohoster.info\/wp-content\/uploads\/2021\/11\/logo-350.jpg\" \/>\n\t\t<meta property=\"og:image:width\" content=\"350\" \/>\n\t\t<meta property=\"og:image:height\" content=\"350\" \/>\n\t\t<meta property=\"article:published_time\" content=\"2019-03-17T21:00:00+00:00\" \/>\n\t\t<meta property=\"article:modified_time\" content=\"2020-02-18T10:44:55+00:00\" \/>\n\t\t<meta property=\"article:publisher\" content=\"https:\/\/www.facebook.com\/prohoster\" \/>\n\t\t<meta property=\"article:author\" content=\"https:\/\/www.facebook.com\/prohoster\" \/>\n\t\t<!-- All in One SEO -->\n\n","aioseo_head_json":{"title":"\ud83e\udd47Benutzerdokumentation: Was macht sie schlecht und wie kann man das verbessern | ProHoster","description":"Softwaredokumentation ist einfach eine Ansammlung von Artikeln. Aber selbst diese k\u00f6nnen frustrierend sein. Zuerst sucht man lange nach der richtigen Anleitung. Dann k\u00e4mpft man sich durch unverst\u00e4ndliche Texte. Man macht es so, wie es geschrieben steht, aber das Problem bleibt ungel\u00f6st. Man sucht nach einem anderen Artikel, wird nerv\u00f6s\u2026 Nach einer Stunde gibt man auf und verl\u00e4sst alles. So funktioniert schlechte Dokumentation. Was macht sie so und wie kann man das \u00e4ndern?","canonical_url":"https:\/\/prohoster.info\/de\/blog\/novosti-interneta\/polzovatelskaya-dokumentatsiya-chto-delaet-eyo-plohoj-i-kak-eto-ispravit","robots":"max-image-preview:large","keywords":"","webmasterTools":{"miscellaneous":""},"schema":null,"og:locale":"de_DE","og:site_name":"ProHoster | \u041a\u0443\u043f\u0438\u0442\u044c \u043d\u0430\u0434\u0435\u0436\u043d\u044b\u0439 \u0445\u043e\u0441\u0442\u0438\u043d\u0433 \u0434\u043b\u044f \u0441\u0430\u0439\u0442\u043e\u0432 \u0441 \u0437\u0430\u0449\u0438\u0442\u043e\u0439 \u043e\u0442 DDoS, VPS VDS \u0441\u0435\u0440\u0432\u0435\u0440\u044b","og:type":"article","og:title":"\ud83e\udd47\u041f\u043e\u043b\u044c\u0437\u043e\u0432\u0430\u0442\u0435\u043b\u044c\u0441\u043a\u0430\u044f \u0434\u043e\u043a\u0443\u043c\u0435\u043d\u0442\u0430\u0446\u0438\u044f: \u0447\u0442\u043e \u0434\u0435\u043b\u0430\u0435\u0442 \u0435\u0451 \u043f\u043b\u043e\u0445\u043e\u0439, \u0438 \u043a\u0430\u043a \u044d\u0442\u043e \u0438\u0441\u043f\u0440\u0430\u0432\u0438\u0442\u044c | ProHoster","og:description":"\u0414\u043e\u043a\u0443\u043c\u0435\u043d\u0442\u0430\u0446\u0438\u044f \u043a \u0441\u043e\u0444\u0442\u0443 \u2014 \u044d\u0442\u043e \u043f\u0440\u043e\u0441\u0442\u043e \u043d\u0430\u0431\u043e\u0440 \u0441\u0442\u0430\u0442\u0435\u0439. \u041d\u043e \u0434\u0430\u0436\u0435 \u043e\u043d\u0438 \u043c\u043e\u0433\u0443\u0442 \u0432\u044b\u0432\u0435\u0441\u0442\u0438 \u0438\u0437 \u0441\u0435\u0431\u044f. \u0421\u043d\u0430\u0447\u0430\u043b\u0430 \u0434\u043e\u043b\u0433\u043e \u0438\u0449\u0435\u0448\u044c \u043d\u0443\u0436\u043d\u0443\u044e \u0438\u043d\u0441\u0442\u0440\u0443\u043a\u0446\u0438\u044e. \u041f\u043e\u0442\u043e\u043c \u0440\u0430\u0437\u0431\u0438\u0440\u0430\u0435\u0448\u044c\u0441\u044f \u0432 \u043c\u0430\u043b\u043e\u043f\u043e\u043d\u044f\u0442\u043d\u043e\u043c \u0442\u0435\u043a\u0441\u0442\u0435. \u0414\u0435\u043b\u0430\u0435\u0448\u044c \u043a\u0430\u043a \u043d\u0430\u043f\u0438\u0441\u0430\u043d\u043e, \u0430 \u043f\u0440\u043e\u0431\u043b\u0435\u043c\u0430 \u043d\u0435 \u0440\u0435\u0448\u0430\u0435\u0442\u0441\u044f. \u0418\u0449\u0435\u0448\u044c \u0434\u0440\u0443\u0433\u0443\u044e \u0441\u0442\u0430\u0442\u044c\u044e, \u043d\u0435\u0440\u0432\u043d\u0438\u0447\u0430\u0435\u0448\u044c\u2026 \u0427\u0435\u0440\u0435\u0437 \u0447\u0430\u0441 \u043f\u043b\u044e\u0451\u0448\u044c \u043d\u0430 \u0432\u0441\u0451 \u0438 \u0443\u0445\u043e\u0434\u0438\u0448\u044c. \u0422\u0430\u043a \u0440\u0430\u0431\u043e\u0442\u0430\u0435\u0442 \u043f\u043b\u043e\u0445\u0430\u044f \u0434\u043e\u043a\u0443\u043c\u0435\u043d\u0442\u0430\u0446\u0438\u044f. \u0427\u0442\u043e \u0434\u0435\u043b\u0430\u0435\u0442 \u0435\u0451 \u0442\u0430\u043a\u043e\u0439, \u0438 \u043a\u0430\u043a \u044d\u0442\u043e \u0438\u0441\u043f\u0440\u0430\u0432\u0438\u0442\u044c","og:url":"https:\/\/prohoster.info\/de\/blog\/novosti-interneta\/polzovatelskaya-dokumentatsiya-chto-delaet-eyo-plohoj-i-kak-eto-ispravit","og:image":"https:\/\/prohoster.info\/wp-content\/uploads\/2021\/11\/logo-350.jpg","og:image:secure_url":"https:\/\/prohoster.info\/wp-content\/uploads\/2021\/11\/logo-350.jpg","og:image:width":350,"og:image:height":350,"article:published_time":"2019-03-17T21:00:00+00:00","article:modified_time":"2020-02-18T10:44:55+00:00","article:publisher":"https:\/\/www.facebook.com\/prohoster","article:author":"https:\/\/www.facebook.com\/prohoster"},"aioseo_meta_data":{"post_id":"42119","title":null,"description":null,"keywords":null,"keyphrases":null,"primary_term":null,"canonical_url":null,"og_title":null,"og_description":null,"og_object_type":"default","og_image_type":"default","og_image_url":null,"og_image_width":null,"og_image_height":null,"og_image_custom_url":null,"og_image_custom_fields":null,"og_video":null,"og_custom_url":null,"og_article_section":null,"og_article_tags":null,"twitter_use_og":false,"twitter_card":"default","twitter_image_type":"default","twitter_image_url":null,"twitter_image_custom_url":null,"twitter_image_custom_fields":null,"twitter_title":null,"twitter_description":null,"schema":{"blockGraphs":[],"customGraphs":[],"default":{"data":{"Article":[],"Course":[],"Dataset":[],"FAQPage":[],"Movie":[],"Person":[],"Product":[],"ProductReview":[],"Car":[],"Recipe":[],"Service":[],"SoftwareApplication":[],"WebPage":[]},"graphName":"","isEnabled":true},"graphs":[]},"schema_type":null,"schema_type_options":null,"pillar_content":false,"robots_default":true,"robots_noindex":false,"robots_noarchive":false,"robots_nosnippet":false,"robots_nofollow":false,"robots_noimageindex":false,"robots_noodp":false,"robots_notranslate":false,"robots_max_snippet":null,"robots_max_videopreview":null,"robots_max_imagepreview":"large","priority":null,"frequency":null,"local_seo":null,"seo_analyzer_scan_date":"2026-01-22 07:20:19","breadcrumb_settings":null,"limit_modified_date":false,"reviewed_by":null,"ai":null,"created":"2021-03-01 00:05:22","updated":"2026-01-22 07:20:19"},"gt_translate_keys":[{"key":"link","format":"url"}],"_links":{"self":[{"href":"https:\/\/prohoster.info\/de\/wp-json\/wp\/v2\/posts\/42119","targetHints":{"allow":["GET"]}}],"collection":[{"href":"https:\/\/prohoster.info\/de\/wp-json\/wp\/v2\/posts"}],"about":[{"href":"https:\/\/prohoster.info\/de\/wp-json\/wp\/v2\/types\/post"}],"author":[{"embeddable":true,"href":"https:\/\/prohoster.info\/de\/wp-json\/wp\/v2\/users\/1"}],"replies":[{"embeddable":true,"href":"https:\/\/prohoster.info\/de\/wp-json\/wp\/v2\/comments?post=42119"}],"version-history":[{"count":0,"href":"https:\/\/prohoster.info\/de\/wp-json\/wp\/v2\/posts\/42119\/revisions"}],"wp:attachment":[{"href":"https:\/\/prohoster.info\/de\/wp-json\/wp\/v2\/media?parent=42119"}],"wp:term":[{"taxonomy":"category","embeddable":true,"href":"https:\/\/prohoster.info\/de\/wp-json\/wp\/v2\/categories?post=42119"},{"taxonomy":"post_tag","embeddable":true,"href":"https:\/\/prohoster.info\/de\/wp-json\/wp\/v2\/tags?post=42119"}],"curies":[{"name":"wp","href":"https:\/\/api.w.org\/{rel}","templated":true}]}}