На этой странице содержится подробная информация о проекте технического написания, принятом для участия в Google Season of Docs.
Краткое описание проекта
- Организация с открытым исходным кодом:
- ГрафQL
- Технический писатель:
- Кэролстран
- Название проекта:
- Создать ресурс часто задаваемых вопросов
- Длина проекта:
- Стандартная продолжительность (3 месяца)
Описание Проекта
Изучение новой технологии никогда не бывает легким и вызывает множество вопросов. Благодаря GraphQL проект развился настолько, что по большей части информация уже доступна. Это просто вопрос его поиска, потому что эта информация разбросана по различным ресурсам и сообществам программистов.
Что-то, что могло бы стать инструментальным улучшением для учащихся GraphQL, — это центральный раздел «Часто задаваемые вопросы» (FAQ). В настоящее время это отсутствует на сайтеgraphql.org и приводит к вопросам, которые либо постоянно повторяются, либо остаются без ответа.
Этот новый раздел часто задаваемых вопросов будет интегрирован в веб-сайт Graphql.org и будет содержать разделы, связанные с:
История и внутреннее устройство GraphQL
- Что такое GraphQL Foundation?
- Когда и почему был создан GraphQL?
- Какие ресурсы лучше всего подходят для начала работы?
Основы GraphQL
- В чем разница между GraphQL и REST/SQL/и т. д.?
- Каковы наилучшие варианты использования GraphQL?
- GraphQL предназначен только для разработчиков React?
Расширенные концепции GraphQL
- Как вы можете кэшировать на стороне сервера с помощью GraphQL?
- Поддерживает ли GraphQL автономное использование?
- Как вы можете протестировать свой GraphQL API?
Спецификация
- Как я могу внести свой вклад в спецификацию?
- Как лучше всего следить за выпусками спецификаций?
И, вероятно, появятся новые разделы. Вышеупомянутые вопросы являются потенциальными примерами. Это также те вопросы, о которых меня спрашивали коллеги, которые учатся или после выступления на конференции, связанной с GraphQL.
Вопросы для часто задаваемых вопросов будут собраны из различных разделов Интернета, а затем отсортированы и расставлены по приоритетам. Некоторые из этих областей включают в себя:
- Переполнение стека
- Проблемы GitHub (в организации GraphQL, How To GraphQL и за ее пределами)
- Твиттер
- Беседы с известными преподавателями GraphQL
- Страницы продуктов, связанные с GraphQL
- Кора
Помимо краткого и полезного контента, последняя страница часто задаваемых вопросов будет создана с учетом UX и доступности.