GraphQL-Projekt

Diese Seite enthält die Details zu einem Projekt für technisches Schreiben, das für die Google-Produktsaison von Google Docs akzeptiert wurde.

Projektzusammenfassung

Open-Source-Organisation:
GraphQL
Technischer Redakteur:
Carolstran
Projektname:
FAQ-Ressource erstellen
Projektdauer:
Standarddauer (3 Monate)

Projektbeschreibung

Es ist nie leicht, sich in eine neue Technologie einzuarbeiten – und das bringt viele Fragen mit sich. Mit GraphQL hat sich das Projekt so weit weiterentwickelt, dass die Informationen zum größten Teil verfügbar sind. Es geht nur darum, sie zu finden, denn diese Informationen sind auf verschiedene Ressourcen und Programmier-Communities verstreut.

Ein zentraler Abschnitt mit häufig gestellten Fragen (FAQs) wäre etwas, das für GraphQL-Lernende eine entscheidende Verbesserung sein könnte. Dies fehlt derzeit auf Graphql.org und führt zu Fragen, die entweder ständig wiederholt werden oder unbeantwortet bleiben.

Dieser neue FAQ-Bereich wird in die Website Graphql.org integriert und enthält Bereiche zu folgenden Themen:

  • Verlauf und Interna von GraphQL

    • Was ist die GraphQL Foundation?
    • Wann und warum wurde GraphQL erstellt?
    • Was sind die besten Ressourcen für den Einstieg?

  • GraphQL-Grundlagen

    • Was ist der Unterschied zwischen GraphQL und REST/SQL/usw.?
    • Was sind die besten Anwendungsfälle für GraphQL?
    • Ist GraphQL nur für React-Entwickler?

  • Erweiterte GraphQL-Konzepte

    • Wie funktioniert serverseitiges Caching mit GraphQL?
    • Unterstützt GraphQL die Offlinenutzung?
    • Wie können Sie Ihre GraphQL API testen?

  • Spezifikation

    • Wie kann ich zur Spezifikation beitragen?
    • Wie lassen sich Spezifikationsfreigaben am besten einhalten?

Und es werden wahrscheinlich weitere Abschnitte folgen. Die obigen Fragen sind mögliche Beispiele. Das sind auch alle, die ich von Kollegen gefragt wurde, die gerade dazulernen oder eine Konferenz über GraphQL gehalten haben.

Die Fragen für die FAQ werden aus verschiedenen Bereichen des Internets bezogen und später sortiert und priorisiert. Dazu gehören unter anderem:

  • StackOverflow
  • GitHub-Probleme (in der GraphQL-Organisation, How To GraphQL und darüber hinaus)
  • Twitter
  • Gespräche mit namhaften GraphQL-Kursleitern
  • GraphQL-bezogene Produktseiten
  • Quora

Neben prägnanten und hilfreichen Inhalten werden bei der Erstellung der FAQ-Seite auch UX und Barrierefreiheit berücksichtigt.