How Engineering Teams Use Guru

Посмотрите, как клиенты RS21 и собственные инженерные команды Guru используют Guru для подготовки своей документации по разработке, включая процессы и шаблоны.
Содержание

Все инженерные команды полагаются на какой-либо инструмент документации для передачи важной информации о продукте своим коллегам. Для небольших команд, которые только начинают, это может быть так же просто, как Google Документ, а для более крупных команд с сложными продуктами это может быть иерархическая вики. В зависимости от того, как организована их компания, другие команды (например, HR или маркетинг) также могут использовать эту вики, или иметь другие области, где они хранят информацию о своей команде.

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

Настройка окружения и ввод в курс дела

При присоединении к новой инженерной команде (внутренне или внешне) процесс ввода в курс дела имеет решающее значение для определения того, насколько быстро новый участник команды почувствует себя готовым внести свой вклад. От настройки их программной среды до изучения документации по функциям, нужно много для того, чтобы прийти в форму и быть готовым взять на себя новую работу.

new-teammate-engineering-resources-png.png

Для многих инженерных команд процесс ввода в курс дела оказывается трудоемким для другого участника команды, который назначается "другом" нового сотрудника и проводит его через эту информацию в реальном времени. Но, предоставляя своей команде экспертно проверенные, актуальные карточки в Guru, лидеры инженерной команды RS21 дают новым сотрудникам гибкость проходить ввод в курс дела в своем собственном темпе. Это позволяет им сэкономить время с "другом" по вводу в курс дела для более межличностного построения отношений или неотложных вопросов.

Когда новый инженер присоединяется к команде RS21, он входит в Guru, чтобы начать работать с материалами для ввода в курс дела. Они рассматривают доску "Информация о команде", где могут немного узнать о своих товарищах по команде, используют карточки инфраструктуры для правильной настройки своих окружений и читают стандарты кодирования своей команды, чтобы понять, как лучше всего взаимодействовать со своими новыми коллегами.

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

Лучшие практики и стандарты команды

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

engineering-overview-branded-png.png

Коллекция инженерных знаний RS21 в Guru включает доску, посвященную процессу руководств, включая карточки с инструкциями по объединению кода, созданию скрипта bash, запросу на обзор кода и другим. У них также есть доски, посвященные согласованному стилю синтаксиса кодирования команды, инструкциям по настройке AWS, информации для системных администраторов и другим. У них даже есть часто используемые фрагменты кода, доступные для легкого копирования и вставки в карточках Guru.

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

В Guru мы привлекаем команды вне нашей организации по разработке продукта, чтобы помочь с нашим процессом обеспечения качества (QA). С более разнообразными взглядами мы лучше можем выявлять ошибки, исследовать потенциальные проблемы клиентов и защищаться от них до выпуска. Но такой технический процесс, как QA, требует документированных инструкций и процедур при привлечении межфункциональных команд. Перед началом QA для новой функции руководитель инженерной команды использует наш шаблон процесса QA, чтобы создать универсальный ресурс для всего, что нужно нашей команде и заинтересованным сторонам для полного QA. Когда мы готовы начать QA, они отправляют это как объявление команде и заинтересованным сторонам и указывают активные даты QA в сообщении.

Планирование проекта и документация по разработке

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

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

feature-details-engineering-png.png

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

По мере продвижения процесса разработки сотрудничество между инженерией и дизайном должно быть на одном уровне. Но из-за часто асинхронного и удаленного характера работы дизайнеры и инженеры не всегда могут поговорить через Zoom, чтобы обсудить любые проблемы или отзывы. Чтобы убедиться, что они следуют нашим согласованным внутренним протоколам для запроса обратной связи по дизайну, наша инженерная команда использует наш обратная связь по дизайну для документации изменений UI в Guru.

Документация, готовая к будущему

Документация всегда была и всегда будет необходимой частью работы инженера. Но то, что когда-то вызывало болезненные всхлипы и понятные вздохи, может стать простой, естественной частью их повседневной жизни, когда это непосредственно внедрено в их рабочий процесс. Расширение браузера Guru приносит документацию прямо в места, где она нужна инженерам, а не заставляет их переключаться на другое, чтобы получить к ней доступ, а экспертно проверенные короткие карточки снимают давление с длинных статей, которые раньше были головной болью при написании и еще сложнее в обслуживании. Так зачем усугублять технический долг устаревшей документацией, когда вы можете легко подготовить ее к будущему прямо сейчас? Начните сегодня бесплатно.

Все инженерные команды полагаются на какой-либо инструмент документации для передачи важной информации о продукте своим коллегам. Для небольших команд, которые только начинают, это может быть так же просто, как Google Документ, а для более крупных команд с сложными продуктами это может быть иерархическая вики. В зависимости от того, как организована их компания, другие команды (например, HR или маркетинг) также могут использовать эту вики, или иметь другие области, где они хранят информацию о своей команде.

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

Настройка окружения и ввод в курс дела

При присоединении к новой инженерной команде (внутренне или внешне) процесс ввода в курс дела имеет решающее значение для определения того, насколько быстро новый участник команды почувствует себя готовым внести свой вклад. От настройки их программной среды до изучения документации по функциям, нужно много для того, чтобы прийти в форму и быть готовым взять на себя новую работу.

new-teammate-engineering-resources-png.png

Для многих инженерных команд процесс ввода в курс дела оказывается трудоемким для другого участника команды, который назначается "другом" нового сотрудника и проводит его через эту информацию в реальном времени. Но, предоставляя своей команде экспертно проверенные, актуальные карточки в Guru, лидеры инженерной команды RS21 дают новым сотрудникам гибкость проходить ввод в курс дела в своем собственном темпе. Это позволяет им сэкономить время с "другом" по вводу в курс дела для более межличностного построения отношений или неотложных вопросов.

Когда новый инженер присоединяется к команде RS21, он входит в Guru, чтобы начать работать с материалами для ввода в курс дела. Они рассматривают доску "Информация о команде", где могут немного узнать о своих товарищах по команде, используют карточки инфраструктуры для правильной настройки своих окружений и читают стандарты кодирования своей команды, чтобы понять, как лучше всего взаимодействовать со своими новыми коллегами.

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

Лучшие практики и стандарты команды

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

engineering-overview-branded-png.png

Коллекция инженерных знаний RS21 в Guru включает доску, посвященную процессу руководств, включая карточки с инструкциями по объединению кода, созданию скрипта bash, запросу на обзор кода и другим. У них также есть доски, посвященные согласованному стилю синтаксиса кодирования команды, инструкциям по настройке AWS, информации для системных администраторов и другим. У них даже есть часто используемые фрагменты кода, доступные для легкого копирования и вставки в карточках Guru.

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

В Guru мы привлекаем команды вне нашей организации по разработке продукта, чтобы помочь с нашим процессом обеспечения качества (QA). С более разнообразными взглядами мы лучше можем выявлять ошибки, исследовать потенциальные проблемы клиентов и защищаться от них до выпуска. Но такой технический процесс, как QA, требует документированных инструкций и процедур при привлечении межфункциональных команд. Перед началом QA для новой функции руководитель инженерной команды использует наш шаблон процесса QA, чтобы создать универсальный ресурс для всего, что нужно нашей команде и заинтересованным сторонам для полного QA. Когда мы готовы начать QA, они отправляют это как объявление команде и заинтересованным сторонам и указывают активные даты QA в сообщении.

Планирование проекта и документация по разработке

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

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

feature-details-engineering-png.png

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

По мере продвижения процесса разработки сотрудничество между инженерией и дизайном должно быть на одном уровне. Но из-за часто асинхронного и удаленного характера работы дизайнеры и инженеры не всегда могут поговорить через Zoom, чтобы обсудить любые проблемы или отзывы. Чтобы убедиться, что они следуют нашим согласованным внутренним протоколам для запроса обратной связи по дизайну, наша инженерная команда использует наш обратная связь по дизайну для документации изменений UI в Guru.

Документация, готовая к будущему

Документация всегда была и всегда будет необходимой частью работы инженера. Но то, что когда-то вызывало болезненные всхлипы и понятные вздохи, может стать простой, естественной частью их повседневной жизни, когда это непосредственно внедрено в их рабочий процесс. Расширение браузера Guru приносит документацию прямо в места, где она нужна инженерам, а не заставляет их переключаться на другое, чтобы получить к ней доступ, а экспертно проверенные короткие карточки снимают давление с длинных статей, которые раньше были головной болью при написании и еще сложнее в обслуживании. Так зачем усугублять технический долг устаревшей документацией, когда вы можете легко подготовить ее к будущему прямо сейчас? Начните сегодня бесплатно.

Опробуйте мощь платформы Гуру на практике - пройдите интерактивный тур по нашему продукту
Пройти экскурсию