Englische Fachdokumentation lesen
Herausforderungen beim Lesen englischer Dokumentation
Abschnitt betitelt „Herausforderungen beim Lesen englischer Dokumentation“Typische Probleme von Nicht-Muttersprachlern beim Lesen englischer Fachdokumentation:
- Ganze Absaetze nicht verstehen, Satz-fuer-Satz-Uebersetzung noetig
- Bei unbekannten Ausdruecken nachschlagen muessen, was den Arbeitsfluss unterbricht
- Nach dem Lesen vergessen oder Ausdruecke gemerkt, aber nicht anwenden koennen
- Gute Beispielsaetze in der Dokumentation, aber keinen Ort zum Speichern
Drei Arbeitsablaeufe
Abschnitt betitelt „Drei Arbeitsablaeufe“Arbeitsablauf 1: Schnelle Wortabfrage (ohne Unterbrechung)
Abschnitt betitelt „Arbeitsablauf 1: Schnelle Wortabfrage (ohne Unterbrechung)“Sie stossen beim Lesen auf einen unbekannten Begriff und moechten ihn schnell verstehen, ohne unterbrochen zu werden.
Vorgehensweise:
- Begriff auswaehlen
- ⌘⇧D druecken (globale Tastenkombination)
- DevGlish-Schwebefenster erscheint mit Definition und Aussprache
- Einmal lesen, schliessen (⌘W)
- Dokumentation weiterlesen
Arbeitsablauf 2: Absatzmodus (tiefes Verstaendnis)
Abschnitt betitelt „Arbeitsablauf 2: Absatzmodus (tiefes Verstaendnis)“Sie stossen auf einen ganzen Absatz, den Sie nicht verstehen, und benoetigen eine satzweise Zerlegung.
Vorgehensweise:
- Ganzen Absatz kopieren
- DevGlish Absatzmodus oeffnen (Menue → Paragraph Mode)
- Text einfuegen
- Claudes satzweise Zerlegung anschauen
Arbeitsablauf 3: Hochwertige Ausdruecke speichern (Bibliothek aufbauen)
Abschnitt betitelt „Arbeitsablauf 3: Hochwertige Ausdruecke speichern (Bibliothek aufbauen)“Beim Lesen entdecken Sie gelungene Formulierungen. Speichern Sie diese, um sie spaeter in eigenen Code Reviews oder Dokumentationen zu verwenden.
Vorgehensweise:
- Satz auswaehlen
- ⌘⇧D druecken
- “Speichern” klicken
- Mit Tags wie “technical-writing” und dem jeweiligen Thema versehen
Best Practices fuer das Dokumentationslesen
Abschnitt betitelt „Best Practices fuer das Dokumentationslesen“1. Erst verstehen, dann Code vertiefen
Abschnitt betitelt „1. Erst verstehen, dann Code vertiefen“Bei komplexen Konzepten:
- Absatzmodus fuer die Dokumentationserklaerung verwenden
- Nach dem Konzeptverstaendnis Code-Beispiele ansehen
- Falls immer noch unklar, Erklaerungsvideos auf YouTube suchen
2. Aktiver Wortschatz (Active Vocabulary)
Abschnitt betitelt „2. Aktiver Wortschatz (Active Vocabulary)“Bei unbekannten Ausdruecken gibt es drei Optionen:
| Vorgehensweise | Szenario | Beispiel |
|---|---|---|
| Schnelle Abfrage (nicht speichern) | Verstehen reicht, kurzfristig nicht benoetigt | ”parameterize” |
| Speichern, nicht wiederholen | Guter Ausdruck, moeglicherweise spaeter nuetzlich | ”achieves decoupling” |
| Speichern + Wiederholen | Haeufig benoetigt, aktiv beherrschen | ”race condition” |
3. Strategie je nach Dokumentationstyp anpassen
Abschnitt betitelt „3. Strategie je nach Dokumentationstyp anpassen“| Dokumentationstyp | Leseweise | Wann speichern |
|---|---|---|
| API-Dokumentation | Schnell scannen, unbekannte Woerter nachschlagen | Parameterbeschreibungen, gaengige Verwendungen |
| Tutorial | Absatzmodus fuer satzweises Verstaendnis | Gute Erklaerungssaetze, Beispielsaetze |
| Design-Dokument | Auf Konzepte fokussieren, Details ignorieren | Architekturbeschreibungen, Design-Abwaegungen |
| Blogartikel | Ganze Absaetze lesen, bei Unklarheiten Absatzmodus | Meinungsdarstellungen, Best-Practice-Ausdruecke |
Schrittweise den Schwierigkeitsgrad steigern
Abschnitt betitelt „Schrittweise den Schwierigkeitsgrad steigern“Phase 1: Einfache Dokumentation (Einstieg)
Abschnitt betitelt „Phase 1: Einfache Dokumentation (Einstieg)“- Django-Anfaengertutorial
- Offizielle API-Einfuehrungsanleitungen
- Mittelschwere Blogartikel
Strategie: Schnelle Wortabfrage + gelegentlich Absatzmodus
Phase 2: Mittlere Schwierigkeit
Abschnitt betitelt „Phase 2: Mittlere Schwierigkeit“- Kubernetes-Offizielle Dokumentation
- Design-Dokumente grosser Open-Source-Projekte
- Hochwertige technische Blogs
Strategie: Absatzmodus fuer komplexe Saetze und unbekannte Konzepte
Phase 3: Hohe Schwierigkeit
Abschnitt betitelt „Phase 3: Hohe Schwierigkeit“- Wissenschaftliche Arbeiten (in Ihrem Fachgebiet)
- Komplexe RFCs (Request For Comments)
- Tiefgehende technische Analysen
Strategie: Zuerst Zusammenfassung oder Erklaervideo lesen, dann Original lesen, mit Absatzmodus fuer jeden Absatz
Schnellreferenz: Drei Schaltflaechen
Abschnitt betitelt „Schnellreferenz: Drei Schaltflaechen“| Schaltflaeche | Aktion | Szenario |
|---|---|---|
| Schnelle Abfrage (⌘⇧D) | Wort auswaehlen → Schwebefenster → Definition sehen → Schliessen | Schnelles Verstaendnis, weiterlesen |
| Absatzmodus | Absatz kopieren → Einfuegen → Satzweise Zerlegung | Ganzen Absatz nicht verstanden oder vertiefen |
| Speichern | Ausdruck auswaehlen → Bei Abfrage speichern | Guter Ausdruck, zur spaeteren Wiederholung oder Verwendung |