Skip to content
readit
readit

leben, technik und kommunikation

  • werkstatt
    • appseits
    • dokumentation
    • software
    • praxistipps
    • referenzen
  • thinkware
    • Gesellschaft
    • public
    • Reisebilder
    • Lyrik
  • Nach­richt an mich
    • Datenschutz
    • Impres­sum
readit
readit

leben, technik und kommunikation

Strukturierung der Dokumentation

15.11.199923.05.2023

Grundsätzlich gibt es immer mehrere Möglichkeiten, Dokumente zu strukturieren, um möglichst effizient das angestrebte Ziel zu erreichen.

Da ist zum einen die Anpassung der vorhandenen Möglichkeiten an das gewünschte Resultat. Das beinhaltet oft die Neuanschaffung von Software, meist sogar auch Hardware – und vor allem neue und kostspielige Lernprozesse und Anpassungsschwierigkeiten derjenigen, die mit den neuen Herausforderungen umgehen sollen.

Am Anfang der Strukturierung der Dokumentation steht nicht nur die Frage nach der Zielgruppe und den Leseerwartungen, sondern auch nach der zweckmäßigsten Lastverteilung.
Erst wenn jedes Element im Dokumentationsprozess die Rolle übernimmt, die seinen Möglichkeiten entspricht, kann optimal und damit auch effizient produziert werden.

Dieser Weg wird oft beschritten, da er sich buchhaltungstechnisch leicht darstellen lässt: Investitionen, Schulungen, Weiterbildungen, Umschulungen oder Neueinstellungen sind leicht zu erfassen. Diese Maßnahmen erfordern jedoch Geld, werden dementsprechend gerne gegen die zu erwartenden Vorteile aufgerechnet. Naturgemäß können dabei keine indirekten Vorteile erfasst oder gar einbezogen werden, die nur mittelbar zum Erfolg beitragen. Vertrauen, Service, Zuverlässigkeit, Imagepflege und Kompatibilität sind Faktoren, die bei den Überlegungen kaum eine Rolle spielen.

Zum anderen verläuft die Anpassung den umgekehrten Weg: Das Ziel wird den vorhandenen Möglichkeiten angepasst, die Anforderungen werden auf das Mindestmaß des Machbaren zurückgeschraubt. Was die Software, der Rechner oder der Kenntnisstand nicht hergibt, das kann eben auch nicht gemacht werden.

Dieser Weg ist der billigere, denn er verlangt keine kostspieligen Investitionen oder Überbrückungszeiten und keine aufwendigen Lernprozesse. Er kann aber zu einer Stagnation führen, die letztendlich den Erfolg in Frage stellt: Stagnation führt zu Resignation und fehlender Innovationsbereitschaft. Wegen fortschreitender und veränderter Anforderungen durch den Leser wird zunehmend am Markt vorbeiproduziert. Frustration und zunehmender Misserfolg stellen sich ein.

Die Innovationsfalle lässt sich umgehen, wenn bereits frühzeitig die Kombination aus Vorhandenem und Gewünschten optimiert wird. Oft werden nämlich selbst die Möglichkeiten außer Acht gelassen, die in dem bereits Vorhandenen stecken.

An diesem Punkt greift die Strukturierung. Eigentlich sollte besser von einer „Dokumentationsorganisation“ gesprochen werden, denn es handelt sich um den frühzeitig angepassten Einsatz der Möglichkeiten und Kenntnisse.

Entsprechend verhält es sich mit den Kenntnissen und Fähigkeiten. Die Kosten und der Zeitaufwand, der für einen suboptimalen Einsatz benötigt wird, übersteigen langfristig die Kosten bei weitem, die für den Aufwand anfallen, eine optimierte Aufgabenverteilung zu erarbeiten.

Teilen mit:

  • Zum Teilen auf Mastodon klicken (Wird in neuem Fenster geöffnet) Mastodon
  • Klicken, um auf WhatsApp zu teilen (Wird in neuem Fenster geöffnet) WhatsApp
  • Klicken, um einem Freund einen Link per E-Mail zu senden (Wird in neuem Fenster geöffnet) E-Mail
  • Klicken, um auf Bluesky zu teilen (Wird in neuem Fenster geöffnet) Bluesky
  • Mehr
  • Klicken zum Ausdrucken (Wird in neuem Fenster geöffnet) Drucken
  • Klick, um auf LinkedIn zu teilen (Wird in neuem Fenster geöffnet) LinkedIn
  • Klicken, um auf Telegram zu teilen (Wird in neuem Fenster geöffnet) Telegram
  • Klick, um auf Pinterest zu teilen (Wird in neuem Fenster geöffnet) Pinterest

Gefällt mir:

Gefällt mir Wird geladen …
dokumentation CMSstrukturtechdok

Beitragsnavigation

Previous post
Next post

Related Posts

dokumentation

Thinking outside the box

03.06.200623.01.2022

Es ist eine alte Krux der technischen Redakteure: Um ein Produkt beschreiben zu können und den gefahrlosen und effektiven Umgang damit darstellen zu können, müssen…

Teilen mit:

  • Zum Teilen auf Mastodon klicken (Wird in neuem Fenster geöffnet) Mastodon
  • Klicken, um auf WhatsApp zu teilen (Wird in neuem Fenster geöffnet) WhatsApp
  • Klicken, um einem Freund einen Link per E-Mail zu senden (Wird in neuem Fenster geöffnet) E-Mail
  • Klicken, um auf Bluesky zu teilen (Wird in neuem Fenster geöffnet) Bluesky
  • Mehr
  • Klicken zum Ausdrucken (Wird in neuem Fenster geöffnet) Drucken
  • Klick, um auf LinkedIn zu teilen (Wird in neuem Fenster geöffnet) LinkedIn
  • Klicken, um auf Telegram zu teilen (Wird in neuem Fenster geöffnet) Telegram
  • Klick, um auf Pinterest zu teilen (Wird in neuem Fenster geöffnet) Pinterest

Gefällt mir:

Gefällt mir Wird geladen …
Read More
dokumentation

Topics: Informationshäppchen hirngerecht servieren

07.01.201528.11.2018

Vor allem im Bereich der Software-Dokumentation ist es oft überraschend, wie viel wir von der Materie zu verstehen glauben und wie wenig wir davon tatsächlich anwenden…

Teilen mit:

  • Zum Teilen auf Mastodon klicken (Wird in neuem Fenster geöffnet) Mastodon
  • Klicken, um auf WhatsApp zu teilen (Wird in neuem Fenster geöffnet) WhatsApp
  • Klicken, um einem Freund einen Link per E-Mail zu senden (Wird in neuem Fenster geöffnet) E-Mail
  • Klicken, um auf Bluesky zu teilen (Wird in neuem Fenster geöffnet) Bluesky
  • Mehr
  • Klicken zum Ausdrucken (Wird in neuem Fenster geöffnet) Drucken
  • Klick, um auf LinkedIn zu teilen (Wird in neuem Fenster geöffnet) LinkedIn
  • Klicken, um auf Telegram zu teilen (Wird in neuem Fenster geöffnet) Telegram
  • Klick, um auf Pinterest zu teilen (Wird in neuem Fenster geöffnet) Pinterest

Gefällt mir:

Gefällt mir Wird geladen …
Read More
dokumentation

Aufmerksamkeits-Steuerung in der Technischen Dokumentation: Hingucken lassen

30.04.201230.12.2023

Dass sowieso keiner die Dokumentation liest, damit haben sich die meisten Redakteure abgefunden. Es stimmt aber nicht. Eine Dokumentation besteht aus zwei Teilen (das wird…

Teilen mit:

  • Zum Teilen auf Mastodon klicken (Wird in neuem Fenster geöffnet) Mastodon
  • Klicken, um auf WhatsApp zu teilen (Wird in neuem Fenster geöffnet) WhatsApp
  • Klicken, um einem Freund einen Link per E-Mail zu senden (Wird in neuem Fenster geöffnet) E-Mail
  • Klicken, um auf Bluesky zu teilen (Wird in neuem Fenster geöffnet) Bluesky
  • Mehr
  • Klicken zum Ausdrucken (Wird in neuem Fenster geöffnet) Drucken
  • Klick, um auf LinkedIn zu teilen (Wird in neuem Fenster geöffnet) LinkedIn
  • Klicken, um auf Telegram zu teilen (Wird in neuem Fenster geöffnet) Telegram
  • Klick, um auf Pinterest zu teilen (Wird in neuem Fenster geöffnet) Pinterest

Gefällt mir:

Gefällt mir Wird geladen …
Read More

Sonst noch was:

  • Produktiver als jeder Montag: Aufgabenverwaltung mit monday.com
  • Aufgabenverwaltung: Work smarter, not harder
  • SVG zähmen leicht gemacht
  • Giro D'Etruria: Toskana und die Emilia Romagna 2025
  • MadCap Flare und Atlassian Confluence: das Powercouple
  • JIRA: Das Monster der Aufgabenverwaltung
  • Radfahren im Bayerischen Wald: Unterwegs am 49. Breitengrad
  • Tools for fools
  • Kommunikation kanalisieren
  • Onlinehilfen: Form follows function
  • Taskworld, der Kopfschmerzvermeider
  • Japan parforce

Beliebt:

  • Impressum
  • Das dürfte fast für einen alternativen Nobelpreis reichen …
  • Fisch oder Auto?
  • La Loire à Vélo
  • Munen musô
  • Kriminell - krimineller - Liechtenstein
  • Referenzen
  • Sesselfurzer, Episode 1
  • Internetnutzung: Wir glotzen auf Waschmaschinen
  • Tschüss Hartmut

Klima und Umwelt

  • Klima vor Acht Das Ziel von KLIMA° vor acht ist es, Fernsehsender zu überzeugen, wissenschaftlich fundierte Klimaberichterstattung zu produzieren, die täglich zur besten Sendezeit ausgestrahlt wird und so viele Zuschauer wie möglich erreicht.

Blog via E-Mail abonnieren

Gib deine E-Mail-Adresse an, um diesen Blog zu abonnieren und Benachrichtigungen über neue Beiträge via E-Mail zu erhalten.

Gern gelesen

  • Das dürfte fast für einen alternativen Nobelpreis reichen …
  • Fisch oder Auto?
  • La Loire à Vélo
  • Munen musô
  • Kriminell - krimineller - Liechtenstein
  • Sesselfurzer, Episode 1
  • Internetnutzung: Wir glotzen auf Waschmaschinen
  • Tschüss Hartmut
  • Kinomap: Die Auspower-App für Ausdauersportler

Hinweis

Es bestehen zu keinen der in diesem Blog genannten Unternehmen und Personen geschäftliche Beziehungen in der Form, dass ich für Werbung oder Vermarktung Geld oder geldwerte Zuwendungen erhalte.

Rechtliches

  • Datenschutz
  • Impressum
Datenschutz und Cookies: Diese Website verwendet Cookies. Wenn du die Website weiterhin nutzt, stimmst du der Verwendung von Cookies zu.

Weitere Informationen, beispielsweise zur Kontrolle von Cookies, findest du hier: Cookie-Richtlinie
©2026 readit | WordPress Theme by SuperbThemes
%d