Aller au contenu

Lire de la documentation technique en anglais

Les défis de la lecture de documentation en anglais

Section intitulée « Les défis de la lecture de documentation en anglais »

Les développeurs non-anglophones rencontrent souvent ces problèmes :

  • ❌ Des paragraphes entiers incompréhensibles, nécessitant une traduction phrase par phrase
  • ❌ Des expressions inconnues qui nécessitent une recherche et interrompent le flux de travail
  • ❌ Lu et oublié, ou les expressions retenues ne sont pas réutilisées
  • ❌ De bons exemples dans les docs, mais nulle part où les sauvegarder

Workflow 1 : Recherche rapide (sans interrompre le travail)

Section intitulée « Workflow 1 : Recherche rapide (sans interrompre le travail) »

Vous lisez de la documentation, rencontrez une expression inconnue, et voulez comprendre rapidement sans vous arrêter.

Opération :

  1. Sélectionnez le terme
  2. Appuyez sur ⌘⇧D (raccourci global)
  3. La fenêtre flottante DevLingo apparaît avec définition et prononciation
  4. Lisez, fermez (⌘W)
  5. Continuez à lire

Workflow 2 : Mode Paragraphe (compréhension approfondie)

Section intitulée « Workflow 2 : Mode Paragraphe (compréhension approfondie) »

Vous rencontrez un paragraphe entier incompréhensible qui nécessite une analyse phrase par phrase.

Opération :

  1. Copiez le paragraphe entier
  2. Ouvrez le mode Paragraphe de DevLingo (Menu → Paragraph Mode)
  3. Collez le texte
  4. Observez l’analyse phrase par phrase de Claude
DevLingo Paragraph Analysis:
Sentence 1: "The descriptor protocol is a beautiful piece of Python..."
Breakdown: descriptor protocol = fonctionnalité Python qui permet de définir le comportement d'accès aux attributs
Key words: protocol, descriptor
Summary: Le descriptor protocol permet de personnaliser l'accès aux attributs via des méthodes spéciales.

Workflow 3 : Sauvegarder les bonnes expressions (constituer une bibliothèque)

Section intitulée « Workflow 3 : Sauvegarder les bonnes expressions (constituer une bibliothèque) »

Vous découvrez de bonnes formulations pendant la lecture. Sauvegardez-les pour les utiliser dans vos propres code reviews ou documents.

Opération :

  1. Sélectionnez l’expression
  2. ⌘⇧D pour ouvrir DevLingo
  3. Cliquez sur “Sauvegarder” (bouton 📌)
  4. Taguez avec “technical-writing” et le domaine approprié
Type de documentMéthodeQuand sauvegarder
Documentation APIScan rapide, recherche des termes inconnusDescriptions de paramètres, usages courants
TutorielsMode Paragraphe phrase par phraseBonnes explications, exemples
Design docsFocus sur les concepts, ignorer les détailsDescriptions d’architecture
Articles de blogLecture globale, mode Paragraphe si flouFormulations d’opinions, meilleures pratiques
TraitementScénarioExemple
Recherche rapide (sans sauvegarder)À comprendre seulement, peu d’usage à court terme”parameterize”
Sauvegarder sans réviserBonne expression, peut être utile”achieves decoupling”
Sauvegarder + réviserCourant, à maîtriser activement”race condition”
Mauvaise compréhensionRaisonBonne compréhension
”achieves” = réalisationsTrop littéral”achieves decoupling” = réalise/atteint le découplage
”leverage” = levierTrop technique”leverage X” = utiliser/exploiter X
”allows X to do Y” est passif ?En réalité actif”allows” a X comme sujet : X peut faire Y
BoutonActionScénario
Recherche rapide (⌘⇧D)Sélectionner → fenêtre flottante → voir définition → fermerCompréhension rapide, continuer à lire
Mode ParagrapheCopier paragraphe → coller → obtenir analysePassage incompréhensible ou compréhension approfondie souhaitée
Sauvegarder (📌)Sélectionner → rechercher → cliquer sauvegarderBonne expression à réviser ou réutiliser