Статья

Новости и Полезные статьи

Наши услуги


Отзывы о Днях разработчиков от Команды документации

Logo

В этом посте команда по документированию и другие участники делятся своими впечатлениями от TYPO3 Developer Days 2019. Они провели сеансы, чтобы обсудить состояние документации, продемонстрировать, как внести свой вклад, и генерировать новые идеи и отзывы.

Узнайте больше о событии: 
Впечатления о T3DD с цитатами от большого числа спикеров и посетителей. 

Что случилось, документы?

TYPO3 Developer Days это отличное событие, чтобы познакомиться с другими разработчиками и напомнить всем, что документация важна и что каждый может внести свой вклад. 

Мы планируем продолжать наши усилия, пока, наконец, вся онлайн-документация на docs.typo3.org не будет обновлена. Но для нас также важно, чтобы содействие было хорошим опытом - это фокус, который у нас уже есть, и где любая помощь ценится!

Мы провели три сессии на Днях разработчиков:

Для нас мероприятие Developer Days было очень мотивирующим, потому что ряд людей выразили заинтересованность не только в том, чтобы внести свой вклад, но и хотели вдохновить коллег на участие в документации. Уже подготовленные инструкции для вклада оказались полезными для успешного входа новичков.

Получен постоянный поток запросов. Новые участники были особенно рады своевременной консолидации вкладов и их публикации. Таким образом, они смогли понять, насколько легко и быстро их ввод улучшает документацию TYPO3.

Давайте послушаем участников

Лина Вольф (Lina Wolf)

TYPO3 Разработчик с 2005 года

Когда я впервые увидел кнопку «Редактировать меня на Github» в официальной документации TYPO3, я подумал: «Кто я такой, чтобы редактировать официальную документацию TYPO3?!». Однако, когда я обнаружил очевидную ошибку (опечатка в коде), я нажал ту кнопку и отправил в исправлении. Ответ от Docs Team был мгновенным и положительным, поэтому я почувствовал желание представить еще несколько небольших изменений. Однако делать масштабные правки в редакторе GitHub было утомительно, и я тоже не решался.

Поэтому, когда на T3DD19 было предложено поговорить о документации, я решил встретиться с парнями за красивыми аккаунтами Github. Я узнал, что вы можете клонировать хранилище документации и работать с ним в автономном режиме, что есть редакторы с подсветкой синтаксиса, которые поддерживают вас, и команда постоянно пытается улучшить как рендеринг, так и контент. И это очень маленькая команда, которая рада любой помощи, которую они могут получить.

Поэтому я решил провести ночь кодирования на документации вместо кодирования. Чтобы что-то понять, вы должны глубоко вникнуть в то, как работает основной код. И вы должны правильно отметить различия между версиями. Это может быть так же сложно, как и внести вклад в ядро. Скорее всего, гораздо больше людей будут читать то, что вы написали. Код, как правило, сам по себе недостаточен для документации, так как любой будет знать, кто работал над проектом при его отсутствии. 

Андреас Недбал (Andreas Nedbal)

Исходя из команды typo3.org, с которой команда по документации уже работала в тесном контакте и даже участвовала в спринте, я всегда был заинтригован тем, что могу внести свой вклад, поэтому Дни разработчика были отличным шансом получить больше информации.

Я присутствовал на всех обсуждениях, связанных с документацией, и присоединился к следующему сеансу мозгового штурма, который был действительно приятным, потому что основное внимание уделялось снижению барьера входа не только для будущих участников документации, но также для начинающих, которые начинают с TYPO3 в целом. Нам удалось выявить некоторые проблемы и предложить решения. Есть гораздо больше вещей, которые мы не освещали, но для обсуждения с 6 людьми за 90 минут мы были весьма продуктивными!

На Coding Night мы собрали небольшую группу из трех человек, чтобы помочь команде по документации с помощью внешнего интерфейса, улучшив дизайн глобальной поисковой системы, которая изначально была «просто работать». Спустя 4 часа работы и много веселья, мы отправили запрос на повторное рассмотрение, когда часы пробили полночь! Вскоре после этого мы получили обратную связь, и только во время завтрака утром она была объединена!

Йорг Куммер (Jörg Kummer)

Как и в предыдущие годы, я действительно с нетерпением ждал, чтобы увидеть знакомые лица и получить новые идеи.

В программе было несколько лекций, объявленных Группой документации, о которых я уже слышал в предыдущих лагерях TYPO3.

Так как я сам работал над вкладом в документацию и знал, что в команде нет поддержки, я решил кратко посетить лекции в этом году. Команда детально подготовила подробное введение в сотрудничество. Мы были быстро обучены, и я мог стабильно организовать свою собственную среду разработки в соответствии со своими потребностями.

Я приобрел опыт благодаря разработке ядра TYPO3, небольшим комментариям и обзорам, а также обмену опытом с другими разработчиками. Я легко перенесу этот опыт в работу с документацией. Вот почему я решил во время дней разработки в Карлсруэ внести часть моих будущих бесплатных ресурсов, чтобы помочь улучшить документацию. Я с нетерпением жду встречи с людьми из группы документации снова.

Подробнее о документации TYPO3

ЛогоНазваниеТипДемоСсылки
image