Dokumentations-Lesezeitrechner

Erhalten Sie eine realistische Lesezeit für Dokumentation mit Code und Screenshots.

Läuft in Ihrem Browser
Keine Uploads
Kein Konto

Dieses Tool analysiert englischen Text.

Ihr Browser-Tool wird geladen…

Was Dokumentations-Lesezeitrechner macht

Ein Entwicklerleitfaden mit drei Codebeispielen und vier Screenshots braucht länger, als seine Wortzahl vermuten lässt. Fügen Sie hier eine Markdown-Seite ein, und die Schätzung rechnet drei Teile zusammen: Fließtext bei 200 Wörtern pro Minute, 3 Sekunden für jede Codezeile und 12 Sekunden für jedes Bild.

Die Kacheln zeigen jeden Teil einzeln, sodass Sie sehen, ob die Zeit in der Erklärung oder in einem langen Konfigurationsbeispiel steckt. Code in abgegrenzten und eingerückten Blöcken wird nach Zeilen gezählt, nicht nach Wörtern. Bilder in Markdown oder in HTML-img-Tags zählen. Ändern Sie die Zeiten für Code und Bilder unter „Weitere Optionen“. Für einfache Artikel ohne Code reicht der Lesezeitrechner.

Beispiel

Eingabe

## Install the CLI
Run the installer, then sign in with your workspace token. The command prints your workspace name when it works.

```bash
npm install -g example-cli
example login
example whoami
```

![Terminal after sign-in](https://example.com/cli.png)

Ergebnis

Reading time: 0:29 (about 1 minute)
Prose: 0:08 (26 words at 200 wpm)
Code: 0:09 (3 lines)
Images: 0:12 (1 image)

Code und Screenshot machen mehr als zwei Drittel der Lesezeit aus, obwohl der Text nur 26 Wörter hat.

Anleitung: Dokumentations-Lesezeitrechner

Fügen Sie die Markdown-Seite ein, oder öffnen Sie mit „Datei öffnen“ eine .md-Datei.
Wählen Sie ein Lesetempo und öffnen Sie dann „Weitere Optionen“, um „Zeit pro Codezeile“ und „Zeit pro Bild“ festzulegen.
Lesen Sie die Kachel „Lesezeit“ und die Aufteilung in „Fließtext“, „Code“ und „Bilder“ ab.

Gut zu wissen

Leerzeilen in Codeblöcken werden nicht gezählt, jede andere Zeile zählt aber gleich, ob sie ein Befehl aus einem Wort oder eine lange Konfigurationszeile ist.
Bilder werden nur aus der Markdown-Bildsyntax und img-Tags gezählt. Eingebettete Videos, Diagramme in iframes und Tabellen fügen keine zusätzliche Zeit hinzu.
Inline-Code in Sätzen zählt als Wörter im Fließtext, nicht als Codezeilen.

Fragen zu Dokumentations-Lesezeitrechner

Wie lange sollte das Lesen einer Dokumentationsseite dauern?

Die meisten Aufgabenseiten funktionieren am besten mit 2 bis 5 Minuten. Leser kommen meist, um eine Aufgabe zu erledigen; eine Seite, die 10 Minuten oder länger dauert, deckt daher oft mehrere Aufgaben ab und ist leichter zu nutzen, wenn sie in getrennte, untereinander verlinkte Seiten aufgeteilt wird.

Sollte ich die Lesezeit auf Dokumentationsseiten anzeigen?

Bei Tutorials und langen Anleitungen hilft sie, weil Leser wissen möchten, ob sie die Zeit haben, bis zum Ende zu kommen. Auf kurzen Referenzseiten ist sie überflüssig. Wenn Sie sie anzeigen, nutzen Sie eine Schätzung, die Code und Bilder einbezieht, denn die Wortzahl allein lässt technische Seiten kürzer erscheinen, als sie sind.

Wie lange dauert es, Code zu lesen?

Pro Wort viel länger als das Lesen von Fließtext, weil Leser die Syntax prüfen und nachvollziehen, was jede Zeile tut. Einige Sekunden pro Zeile sind ein vernünftiger Durchschnitt für vertrauten Code. Erhöhen Sie die Zeit pro Zeile bei komplexen Beispielen oder für Leser, die die Sprache noch nicht kennen.