Zum Inhalt springen

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

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:

  1. Begriff auswaehlen
  2. ⌘⇧D druecken (globale Tastenkombination)
  3. DevGlish-Schwebefenster erscheint mit Definition und Aussprache
  4. Einmal lesen, schliessen (⌘W)
  5. 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:

  1. Ganzen Absatz kopieren
  2. DevGlish Absatzmodus oeffnen (Menue → Paragraph Mode)
  3. Text einfuegen
  4. 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:

  1. Satz auswaehlen
  2. ⌘⇧D druecken
  3. “Speichern” klicken
  4. Mit Tags wie “technical-writing” und dem jeweiligen Thema versehen

Bei komplexen Konzepten:

  1. Absatzmodus fuer die Dokumentationserklaerung verwenden
  2. Nach dem Konzeptverstaendnis Code-Beispiele ansehen
  3. Falls immer noch unklar, Erklaerungsvideos auf YouTube suchen

Bei unbekannten Ausdruecken gibt es drei Optionen:

VorgehensweiseSzenarioBeispiel
Schnelle Abfrage (nicht speichern)Verstehen reicht, kurzfristig nicht benoetigt”parameterize”
Speichern, nicht wiederholenGuter Ausdruck, moeglicherweise spaeter nuetzlich”achieves decoupling”
Speichern + WiederholenHaeufig benoetigt, aktiv beherrschen”race condition”
DokumentationstypLeseweiseWann speichern
API-DokumentationSchnell scannen, unbekannte Woerter nachschlagenParameterbeschreibungen, gaengige Verwendungen
TutorialAbsatzmodus fuer satzweises VerstaendnisGute Erklaerungssaetze, Beispielsaetze
Design-DokumentAuf Konzepte fokussieren, Details ignorierenArchitekturbeschreibungen, Design-Abwaegungen
BlogartikelGanze Absaetze lesen, bei Unklarheiten AbsatzmodusMeinungsdarstellungen, Best-Practice-Ausdruecke
  • Django-Anfaengertutorial
  • Offizielle API-Einfuehrungsanleitungen
  • Mittelschwere Blogartikel

Strategie: Schnelle Wortabfrage + gelegentlich Absatzmodus

  • Kubernetes-Offizielle Dokumentation
  • Design-Dokumente grosser Open-Source-Projekte
  • Hochwertige technische Blogs

Strategie: Absatzmodus fuer komplexe Saetze und unbekannte Konzepte

  • 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

SchaltflaecheAktionSzenario
Schnelle Abfrage (⌘⇧D)Wort auswaehlen → Schwebefenster → Definition sehen → SchliessenSchnelles Verstaendnis, weiterlesen
AbsatzmodusAbsatz kopieren → Einfuegen → Satzweise ZerlegungGanzen Absatz nicht verstanden oder vertiefen
SpeichernAusdruck auswaehlen → Bei Abfrage speichernGuter Ausdruck, zur spaeteren Wiederholung oder Verwendung