На этой странице содержится подробная информация о проекте технического написания, принятом для участия в Google Season of Docs.
Краткое описание проекта
- Организация с открытым исходным кодом:
- Апач Флинк
- Технический писатель:
- хасиб1431
- Название проекта:
- Расширение документации API таблиц и SQL для Apache Flink
- Длина проекта:
- Стандартная продолжительность (3 месяца)
Описание проекта
Я подаю заявку на GSOD по теме «Расширение документации по API таблиц и SQL». Мы напишем документацию по API, чтобы бабушка тоже могла писать запросы. Хотя, возможно, у нас уже есть структура, но мы пройдемся по ней как начинающие пользователи и предложим идеи там, где это необходимо. Я планирую тесно сотрудничать с наставниками, чтобы понять их мыслительный процесс, а также делиться различными идеями, основанными на моем предыдущем опыте в отрасли.
Некоторые из первоначальных мыслей, основанных на текущей документации:
Страница обзора в настоящее время содержит много информации, но ее необходимо пересмотреть и упорядочить таким образом, чтобы как новичок, так и опытный пользователь могли быстро начать работу. Моя идея состоит в том, чтобы начать работу с различными возможными треками: а) запустить новый проект и затем выполнить запросы поверх него, б) запустить запросы SQL или Table API поверх существующего проекта.
Нам также необходимо иметь полную карту документации API на целевой странице, чтобы пользователи могли увидеть все возможности с первого взгляда. Это будет улучшенная версия раздела «Куда идти дальше» на текущей обзорной странице.
Концептуальная страница имеет неплохой контент, но его слишком много на одной странице, поэтому на этой странице будет несколько подразделов. Аналогично, другие разделы «Планировщики», «Встроенные функции», «Соединители» нуждаются в большей видимости, возможно, на странице обзора или на левой панели навигации. Страницу соединителей можно разделить на несколько подразделов, например соединители, форматы и т. д. Системные (встроенные) функции мне нравятся, поскольку у нас есть все возможные методы, доступные на одной странице, и пользователи могут постоянно обращаться к ним как к шпаргалкам, но будут рады добавить к этому больше контента.
Трехмесячный период будет разделен на несколько этапов. Первоначально мы создадим структуру, например карту сайта, документации API таблиц и SQL. Мы представим подразделы и представим сюжетные линии, как описано выше. После завершения мы сможем просмотреть его с пользователями продвинутого и начального уровня. С другой стороны, мы можем начать писать о планировщиках, коннекторах, пока ждем фидбека. Как только мы получим обратную связь, мы реструктурируем нашу документацию по API. Далее мы сосредоточимся на завершении написания ожидающих разделов. Наконец, если позволит время, я планирую взять пример с нуля и продемонстрировать комплексную реализацию проекта, который можно будет использовать для FLINK-12639.
Я предлагаю провести часовую встречу через 2 недели, кроме чатов в Slack (или любых других инструментах). Я поделюсь первоначальным графиком проекта с указанием ожидаемых недель, что также поможет нам отслеживать ход проекта на еженедельной основе.
Наконец, эта документация похожа на наш блог на Medium.com, где мы добавляем все основные детали, когда изучаем различные функции Flink API. Это также делает меня уникальным кандидатом, поскольку я буду проверять документацию с помощью практических реализаций, а не просто писать техническую документацию. Этот проект будет для меня двойным мечом, поскольку я буду вносить свой вклад в документацию с открытым исходным кодом, одновременно изучая API таблиц и SQL.