Calculateur de temps de lecture de documentation

Obtenez un temps de lecture réaliste pour une documentation avec du code et des captures.

Fonctionne dans votre navigateur
Aucun envoi de fichier
Aucun compte

Cet outil analyse du texte en anglais.

Chargement de l'outil dans votre navigateur…

Ce que fait Calculateur de temps de lecture de documentation

Un guide pour développeurs avec trois exemples de code et quatre captures d’écran se lit plus lentement que son nombre de mots ne le laisse penser. Collez une page Markdown ici : l’estimation additionne trois parties, le texte à 200 mots par minute, 3 secondes par ligne de code et 12 secondes par image.

Les vignettes affichent chaque partie séparément : vous voyez si le temps se trouve dans l’explication ou dans un long exemple de configuration. Le code des blocs délimités et indentés est compté par ligne, pas par mot. Les images en Markdown ou en balises img HTML comptent. Modifiez les temps du code et des images dans « Plus d’options ». Pour des articles sans code, le Calculateur de temps de lecture suffit.

Exemple

Entrée

## 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)

Résultat

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)

Le code et la capture d’écran représentent plus des deux tiers du temps de lecture, alors que le texte ne compte que 26 mots.

Mode d'emploi : Calculateur de temps de lecture de documentation

Collez la page Markdown, ou utilisez « Ouvrir un fichier » pour un fichier .md.
Choisissez une « Vitesse de lecture », puis ouvrez « Plus d’options » pour régler « Temps par ligne de code » et « Temps par image ».
Lisez la vignette « Temps de lecture » et le détail « Texte », « Code » et « Images ».

Bon à savoir

Les lignes vides dans les blocs de code ne sont pas comptées, mais toutes les autres lignes comptent de la même façon, qu’il s’agisse d’une commande d’un mot ou d’une longue ligne de configuration.
Les images ne sont comptées qu’à partir de la syntaxe d’image Markdown et des balises img. Les vidéos intégrées, les schémas dans des iframes et les tableaux n’ajoutent pas de temps.
Le code en ligne dans les phrases compte comme des mots de texte, pas comme des lignes de code.

Questions sur Calculateur de temps de lecture de documentation

Combien de temps doit prendre la lecture d’une page de documentation ?

La plupart des pages de tâche fonctionnent mieux entre 2 et 5 minutes. Les lecteurs arrivent généralement pour accomplir une tâche : une page qui demande 10 minutes ou plus couvre souvent plusieurs tâches et serait plus simple à utiliser découpée en pages distinctes reliées entre elles.

Faut-il afficher le temps de lecture sur les pages de documentation ?

C’est utile sur les tutoriels et les guides longs, où les lecteurs veulent savoir s’ils auront le temps de terminer. Sur les courtes pages de référence, cela encombre. Si vous l’affichez, utilisez une estimation qui inclut le code et les images, car les mots seuls sous-estiment les pages techniques.

Combien de temps faut-il pour lire du code ?

Bien plus longtemps par mot que du texte, car le lecteur vérifie la syntaxe et comprend ce que fait chaque ligne. Quelques secondes par ligne sont une moyenne raisonnable pour du code familier. Augmentez le temps par ligne pour des exemples complexes ou des lecteurs qui découvrent le langage.