Proyecto de GraphQL

Esta página contiene los detalles de un proyecto de redacción técnica aceptado para la GDOC Season of Docs.

Resumen del proyecto

Organización de código abierto:
GraphQL
Redactor técnico:
carolstran
Nombre del proyecto:
Crea un recurso de Preguntas frecuentes
Duración del proyecto:
Duración estándar (3 meses)

Project description

Aprender una tecnología nueva nunca es fácil y genera muchas preguntas. Con GraphQL, el proyecto evolucionó lo suficiente como para que, en su mayor parte, la información esté disponible. Solo es cuestión de encontrarla, ya que esa información está dispersa en varios recursos y comunidades de programación.

Algo que podría ser una mejora instrumental para los estudiantes de GraphQL sería una sección central de preguntas frecuentes (FAQ). Actualmente, esto no está disponible en graphql.org y genera preguntas que se repiten constantemente o que no se responden.

Esta nueva sección de preguntas frecuentes se integrará en el sitio web de graphql.org y contendrá secciones relacionadas con lo siguiente:

  • Historial y elementos internos de GraphQL

    • ¿Qué es la GraphQL Foundation?
    • ¿Cuándo y por qué se creó GraphQL?
    • ¿Cuáles son los mejores recursos para comenzar?

  • Conceptos básicos de GraphQL

    • ¿Cuál es la diferencia entre GraphQL y REST/SQL/etc.?
    • ¿Cuáles son los mejores casos de uso de GraphQL?
    • ¿GraphQL es solo para desarrolladores de React?

  • Conceptos avanzados de GraphQL

    • ¿Cómo puedes hacer la caché del servidor con GraphQL?
    • ¿GraphQL admite el uso sin conexión?
    • ¿Cómo puedes probar tu API de GraphQL?

  • Especificación

    • ¿Cómo puedo contribuir a la especificación?
    • ¿Cuál es la mejor manera de seguir los lanzamientos de especificaciones?

Y es probable que agreguemos más secciones. Las preguntas anteriores son posibles ejemplos. También son todas las que me hicieron colegas que están aprendiendo o después de dar una charla en una conferencia relacionada con GraphQL.

Las preguntas de las preguntas frecuentes se obtendrán de varias áreas de Internet y, luego, se ordenarán y priorizarán. Entre estas áreas, se incluyen las siguientes:

  • StackOverflow
  • Problemas de GitHub (en la organización de GraphQL, How To GraphQL y más)
  • Twitter
  • Conversaciones con instructores destacados de GraphQL
  • Páginas de productos relacionadas con GraphQL
  • Quora

Además de tener un contenido breve y útil, la página final de preguntas frecuentes se diseñará teniendo en cuenta la UX y la accesibilidad.