GraphQL-Projekt

Auf dieser Seite finden Sie die Details zu einem Projekt für technisches Schreiben, das für Google Season of Docs angenommen wurde.

Projektzusammenfassung

Open-Source-Organisation:
GraphQL
Technischer Redakteur:
carolstran
Projektname:
FAQ-Ressource erstellen
Projektlänge:
Standardlänge (3 Monate)

Projektbeschreibung

Neue Technologien zu erlernen, ist nie einfach – und sie bringt viele Fragen mit sich. Mit GraphQL hat sich das Projekt so weiterentwickelt, dass die Informationen größtenteils verfügbar sind. Es geht nur darum, sie zu finden, da diese Informationen in verschiedenen Ressourcen und Programmiergemeinden verstreut sind.

Eine zentrale FAQ-Seite könnte eine wichtige Verbesserung für Lernende von GraphQL sein. Das ist derzeit auf graphql.org nicht der Fall, was zu Fragen führt, die entweder ständig wiederholt oder unbeantwortet bleiben.

Dieser neue Abschnitt mit FAQs wird in die Website graphql.org eingebunden und enthält Abschnitte zu folgenden Themen:

  • GraphQL-Verlauf und -Interna

    • 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/etc.?
    • Was sind die besten Anwendungsfälle für GraphQL?
    • Ist GraphQL nur für React-Entwickler geeignet?

  • Erweiterte GraphQL-Konzepte

    • Wie kann ich serverseitiges Caching mit GraphQL durchführen?
    • Unterstützt GraphQL die Offlinenutzung?
    • Wie können Sie Ihre GraphQL API testen?

  • Spezifikation

    • Wie kann ich zur Spezifikation beitragen?
    • Wie können Sie die Veröffentlichungen der Spezifikationen am besten verfolgen?

Es werden wahrscheinlich noch weitere Bereiche hinzukommen. Die obigen Fragen sind mögliche Beispiele. Außerdem sind es Fragen, die mir von Kollegen gestellt wurden, die sich mit GraphQL beschäftigen, oder die ich nach einem Vortrag zu GraphQL auf einer Konferenz erhalten habe.

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

  • Stack Overflow
  • GitHub-Probleme (in der GraphQL-Organisation, How To GraphQL und darüber hinaus)
  • Twitter
  • Gespräche mit bekannten GraphQL-Lehrkräften
  • GraphQL-bezogene Produktseiten
  • Quora

Neben prägnanten und hilfreichen Inhalten wird die endgültige FAQ-Seite auch im Hinblick auf UX und Barrierefreiheit gestaltet.