Die 4 Arten von technischer Dokumentation am Beispiel eines Zitronenkuchens

Am Wochenende war ich in Prag. Die WriteTheDocs Community hatte ihre EU Konferenz und ich, neu in Tech Docs, war zum ersten Mal dabei:

http://www.writethedocs.org/conf/eu/2017/

Den Eröffungs-Vortrag hielt Daniele Procida mit dem Titel
“The four kinds of documentation, and why you need to understand what they are”

Und das sind sie, die vier Arten der Dokumentation:

  • klassifiziert mit ihrem Fokus
  • gruppiert nach
    • lernen oder tun
    • Theorie oder Praxis
TUTORIAL learning studying practice
HOW-TO problem-solving doing practice
EXPLANATION understanding studying theory
REFERENCE information doing theory

Ich habe nun auch den Unterschied zwischen einem Tutorial und einem How-To verstanden, die ich übrigens beide als “Anleitung” übersetzt bekomme.

Das Tutorial lehrt, wie es prinzipiell geht. Dies gern an einem Beispiel. Es geht aber um das Lernen. “Wir lernen einen Kuchen backen.”

Das How-To erklärt ein konkretes Thema. Das Thema ist eben gerade kein Beispiel, sondern das, worum es geht. Sie setzt ein gewisses Grundverständnis voraus, zum Beispiel wie man einen Kuchen backt und wie man ein Rezept liest. “Wir backen einen Zitronenkuchen.” wird dann das Zitronenkuchenrezept.

In der Referenz kann ich nachschlagen, welche Backeigenschaften das Mehl hat und was eine Kastenform ist.

Eine Erklärung kann die Vor- und Nachteile des Genusses eines Stück Zitronenkuchens für die menschliche Ernährung darstellen.

Der Inhalt dieser Webseite ist mein persönliches Informationsangebot. Ich übernehme keinerlei Verantwortung für hier verlinkte Inhalte anderer WWW-Seiten und sonstiger Materialien

Tagged with:
Posted in Wissensmanagement
One comment on “Die 4 Arten von technischer Dokumentation am Beispiel eines Zitronenkuchens
  1. Anleitung lässt sich noch feiner untergliedern, wie ich von
    https://www.technische-dokumentation.de/checklisten/zielgruppe/zielgruppe.html
    gelernt habe, und zwar in:
    Kurzanleitung (Erklärung),
    Sofortanleitung (Hands on),
    Lernanleitung (tutorial) und
    Nachschlageanleitung (Referenzinformation).

Leave a Reply

Fill in your details below or click an icon to log in:

WordPress.com Logo

You are commenting using your WordPress.com account. Log Out /  Change )

Google photo

You are commenting using your Google account. Log Out /  Change )

Twitter picture

You are commenting using your Twitter account. Log Out /  Change )

Facebook photo

You are commenting using your Facebook account. Log Out /  Change )

Connecting to %s

%d bloggers like this: