Progetto GraphQL

Questa pagina contiene i dettagli di un progetto di documentazione tecnica accettato per la stagione della documentazione di Google.

Riepilogo del progetto

Organizzazione open source:
GraphQL
Redattore tecnico:
carolstran
Nome del progetto:
Creare una risorsa di domande frequenti
Durata del progetto:
Durata standard (3 mesi)

Project description

Imparare una nuova tecnologia non è mai facile e comporta molte domande. Con GraphQL, il progetto è evoluto abbastanza da rendere disponibili le informazioni per la maggior parte. È solo questione di trovarle, perché queste informazioni sono sparse in varie risorse e community di programmazione.

Un miglioramento strumentale per gli studenti di GraphQL potrebbe essere una sezione centrale di domande frequenti (FAQ). Al momento non è presente su graphql.org e porta a domande che vengono ripetute costantemente o lasciate senza risposta.

Questa nuova sezione di domande frequenti verrà integrata nel sito web graphql.org e conterrà sezioni relative a:

  • Cronologia e componenti interni di GraphQL

    • Che cos'è la GraphQL Foundation?
    • Quando e perché è stato creato GraphQL?
    • Quali sono le risorse migliori per iniziare?

  • Nozioni di base su GraphQL

    • Qual è la differenza tra GraphQL e REST/SQL/ecc.?
    • Quali sono i casi d'uso migliori per GraphQL?
    • GraphQL è disponibile solo per gli sviluppatori React?

  • Concetti avanzati di GraphQL

    • Come faccio a eseguire la memorizzazione nella cache lato server con GraphQL?
    • GraphQL supporta l'utilizzo offline?
    • Come puoi testare la tua API GraphQL?

  • Specifica

    • Come posso contribuire alla specifica?
    • Qual è il modo migliore per seguire le release delle specifiche?

E probabilmente altre sezioni in arrivo. Le domande precedenti sono potenziali esempi. Inoltre, sono tutte domande che mi sono state poste da colleghi che stanno imparando o dopo che ho tenuto un discorso in una conferenza relativo a GraphQL.

Le domande nelle Domande frequenti verranno scelte in varie aree di Internet e in seguito verranno ordinate e ordinate per priorità. Ecco alcune di queste aree:

  • StackOverflow
  • Problemi di GitHub (nell'organizzazione GraphQL, nella documentazione How To GraphQL e altro ancora)
  • Twitter
  • Conversazioni con insegnanti GraphQL di spicco
  • Pagine di prodotto correlate a GraphQL
  • Quora

Oltre a contenuti concisi e utili, la pagina finale delle domande frequenti verrà creata tenendo conto dell'esperienza utente e dell'accessibilità.