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
Trois workflows
Section intitulée « Trois workflows »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 :
- Sélectionnez le terme
- Appuyez sur ⌘⇧D (raccourci global)
- La fenêtre flottante DevLingo apparaît avec définition et prononciation
- Lisez, fermez (⌘W)
- 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 :
- Copiez le paragraphe entier
- Ouvrez le mode Paragraphe de DevLingo (Menu → Paragraph Mode)
- Collez le texte
- 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 :
- Sélectionnez l’expression
- ⌘⇧D pour ouvrir DevLingo
- Cliquez sur “Sauvegarder” (bouton 📌)
- Taguez avec “technical-writing” et le domaine approprié
Bonnes pratiques pour la lecture de documentation
Section intitulée « Bonnes pratiques pour la lecture de documentation »Adapter la stratégie au type de document
Section intitulée « Adapter la stratégie au type de document »| Type de document | Méthode | Quand sauvegarder |
|---|---|---|
| Documentation API | Scan rapide, recherche des termes inconnus | Descriptions de paramètres, usages courants |
| Tutoriels | Mode Paragraphe phrase par phrase | Bonnes explications, exemples |
| Design docs | Focus sur les concepts, ignorer les détails | Descriptions d’architecture |
| Articles de blog | Lecture globale, mode Paragraphe si flou | Formulations d’opinions, meilleures pratiques |
Gestion du vocabulaire actif
Section intitulée « Gestion du vocabulaire actif »| Traitement | Scénario | Exemple |
|---|---|---|
| Recherche rapide (sans sauvegarder) | À comprendre seulement, peu d’usage à court terme | ”parameterize” |
| Sauvegarder sans réviser | Bonne expression, peut être utile | ”achieves decoupling” |
| Sauvegarder + réviser | Courant, à maîtriser activement | ”race condition” |
Erreurs de compréhension courantes
Section intitulée « Erreurs de compréhension courantes »| Mauvaise compréhension | Raison | Bonne compréhension |
|---|---|---|
| ”achieves” = réalisations | Trop littéral | ”achieves decoupling” = réalise/atteint le découplage |
| ”leverage” = levier | Trop 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 |
Référence rapide : trois boutons
Section intitulée « Référence rapide : trois boutons »| Bouton | Action | Scénario |
|---|---|---|
| Recherche rapide (⌘⇧D) | Sélectionner → fenêtre flottante → voir définition → fermer | Compréhension rapide, continuer à lire |
| Mode Paragraphe | Copier paragraphe → coller → obtenir analyse | Passage incompréhensible ou compréhension approfondie souhaitée |
| Sauvegarder (📌) | Sélectionner → rechercher → cliquer sauvegarder | Bonne expression à réviser ou réutiliser |