Ревю документов что это такое
Что такое код-ревью
Это проверка кода на ошибки, неточности и общий стиль программирования.
Послушать аудиоверсию этой статьи (6 минут):
Слушайте Что такое код-ревью на Яндекс.Музыке
Ситуация: вы разработчик. Вы отвечаете за свой фронт работы, например, за отправку данных на сервер. У команды уже есть готовый проект, вы вместе его поддерживаете и постоянно улучшаете.
Когда вы пишете новую функцию, она не попадает сразу в проект. Вместо этого ваш код отправляется на код-ревью (code review).
Что делают на код-ревью
Во время код-ревью кто-то из старших товарищей изучает ваш код на предмет:
Если проблемы есть, проверяющий отправляет код на доработку. Если всё хорошо, код переходит на следующую стадию — как правило, в тестирование.
Кто проводит
Обычно принято так: код-ревью делают программисты более старшего уровня. Джуниоров проверяют мидлы, мидлов — сеньоры, сеньоров — другие сеньоры или тимлиды. Если компания большая, то могут выделить отдельно несколько человек, которые смотрят код у всех и следят за общим стилем.
Если команда небольшая, то код-ревью делает ведущий программист — он сам следит за проектом и за качеством кода, который пишут остальные.
Как это выглядит
Зачем это нужно
Если вы пишете один или с другом, то, скорее всего, вам это не нужно. Вы и так можете обсудить код между собой и понять, как его сделать лучше.
Когда в команде программистов много, то компания сталкивается с тем, что все пишут по-разному. И даже если весь этот код работает, его потом нужно поддерживать, а ковыряться в чужом коде, если он плохо написан — это долго и дорого. Поэтому на этапе код-ревью разработчики делают так, чтобы им же позднее было проще поддерживать код и ничего не ломалось.
Что такое код-ревью и кто им занимается?
Эффективный способ заботиться о качестве кода
Проверка кода — это как базовое правило гигиены. Разработчики могут создавать запутанный и тяжелый код. Его сложнее обслуживать, а сбои появляются там, где не ждешь. Поэтому важная часть работы над продуктом — код-ревью, когда более опытные разработчики проверяют качество кода. Мы поговорили с Андреем Строговым, который руководит код-ревьюерами в Яндекс.Практикуме, о главных качествах такого профессионала и бесполезных комментариях к коду.
Задачи код-ревьюера
Код-ревью — это этап разработки кода. Чаще всего его проводят другие разработчики из той же команды. Так более опытные кодеры контролируют качество работы джуниоров или стажеров. Ревьюер на отдельных компонентах может показать, как сделать код проще и понятнее. Например, предложит взять функцию, которая уже написана для другого фрагмента. Проверка кода особенно важна для работы больших команд.
«В масштабных проектах код очень объемный и каждый разработчик знает только свой фрагмент. Люди часто не в курсе, что происходит в других компонентах и модулях. Это не слишком устойчивая ситуация, потому что автор кода может уйти в отпуск или по разным причинам перестать поддерживать свой фрагмент. Этап код-ревью добавляет второго человека, который понимает код и может с ним работать», — говорит руководитель команды код-ревью Андрей Строгов.
Код-ревью — это хороший способ договориться внутри команды, как писать код. Например, запутанный код сложно поддерживать в рабочем состоянии и масштабировать. Этап код-ревью помогает обмениваться знаниями, находить новые решения, делать лучше весь процесс разработки.
В отличие от тестирования, на код-ревью важнее разобраться в логике решения, чем найти ошибки. А еще — донести суть проблемы до разработчика. Для этого понадобится умение точно формулировать проблему и сообщать о ней без лишних эмоций.
«Когда мы проверяем код, не надо тратить время на мелкие ошибки — названия переменных, опечатки. Это плохо влияет и на того, кто пишет код, и на проверяющего. В первую очередь автору нужна обратная связь по логике кода. Проверку мелких ошибок легко автоматизировать», — говорит Андрей Строгов.
Этапы работы и инструменты
Код-ревьюер движется от общего к частному. Сначала ему нужно понять, какую задачу решал автор кода. Для этого проверяющий смотрит техническое задание и уточняет детали у разработчика. Дальше нужно оценить архитектуру кода и посмотреть, грамотно ли он написан. Это самый ценный этап код-ревью, он помогает избежать грубых ошибок и сэкономить время команде тестирования.
Когда ревьюер разобрался с задачей и логикой решения, он смотрит на функции, отдельные алгоритмы и их эффективность. Проверяет, можно ли заменить их другими методами и будет ли это лучше для всего продукта.
«На этих этапах не нужно никаких специальных инструментов. Только экспертные навыки и знание задачи. Код-ревьюеру понадобятся некоторые инструменты среды лишь для того, чтобы посмотреть, как работает код, и обнаружить грубые ошибки», — говорит Андрей Строгов.
После проверки ревьюер оставляет комментарии для разработчика. Его задача на этом этапе — объяснить, почему важно исправить ошибку. А еще проверяющий может подсказать решение или дать ссылки на материалы, с которыми разработчик быстрее приведет код в порядок. Весь процесс проверки не должен тормозить остальную разработку — хорошо, если код-ревью удается закончить за время рабочего дня.
«Наша задача в том, чтобы разработчик понял, в чём заключается комментарий и почему важно исправить код в соответствии с ним. Для этого недостаточно сильных технических знаний, нужны хорошие soft skills. Если ревьюер дал полезный комментарий, а разработчик почему-то не захотел исправлять — это будет выглядеть глупо», — говорит Андрей Строгов.
Полезный комментарий помогает исправить и улучшить код. А еще в нём нет субъективной оценки или нотаций. Поэтому критически важно, чтобы код-ревьюер умел давать качественную обратную связь. Иначе автор примет замечания на свой счет, и никакой эффективной работы не получится.
«Не стоит оставлять комментарии в духе “бред какой-то” или “тут ты не подумал”. Нужно формулировать проблему корректно. Субъективное мнение тоже не помогает улучшить код. Лучше найти что-то точнее, чем “это непонятный код”», — говорит Андрей Строгов.
Кроме комментариев код-ревьюер может оставлять рекомендации. Это некритичные замечания, их можно взять в работу, если у разработчика останется время. Например, проверяющий видит, что код выглядит запутанным. Задача решена, и весь функционал в порядке, но кажется, что работа сделана небрежно. Тут можно обойтись рекомендацией — обратить внимание человека на эту особенность его решения.
«Вы сэкономите время команде, если выделите критичные замечания. Это замечания, касающиеся фрагментов, которые могут привести к некорректной работе кода или помешают расширить его в будущем. Еще сюда относятся ошибки, из-за которых код трудно поддерживать и редактировать», — говорит Андрей Строгов.
Знания и навыки
Чтобы проверять код, нужно в нём разбираться. Хорошо, чтобы ревьюер уже решал такие задачи, писал подобный код и был знаком с тем стеком технологий, который используют в команде. Тогда ревьюер сможет дать разработчику полезные комментарии.
«Нужно отучить себя от того, что ты обязательно должен написать комментарии после ревью. Если с кодом всё в порядке, он может вернуться к автору без замечаний, которые оставляют ради самих замечаний», — говорит Андрей Сторогов.
Важно смотреть на код с позиции автора. У ревьюера может быть свой способ работы с кодом или другое решение для конкретной задачи. Но вся ценность его работы — предложить улучшения, ориентируясь на методы работы автора кода.
«Для команды хорошо, когда ревьюер может искренне похвалить удачное решение, — говорит Андрей Строгов. — Разработчики делятся на две категории. Одни считают, что пишут идеальный код, другие — что их код плох. Поэтому важно научиться искренне хвалить за хорошие решения. Это приятно автору кода и укрепляет отношения в команде».
Стать хорошим ревьюером помогает практика. Если в вашей команде пока нет такой деятельности, можно искать подходящие проекты на GitHub и оставлять комментарии там. «Код-ревью влияет на качество кода уже самим фактом своего существования, —говорит Андрей Строгов. — Когда знаешь, что твой код посмотрят, тщательнее к нему относишься. Например, постараешься его понятно оформить, не будешь использовать запутанную логику, в которой не смог бы разобраться другой разработчик. Это полезная социальная составляющая, которая мотивирует делать более понятный код».
Что такое ревью и какова его структура?
Чтобы не кривить душой, скажем, что ревью – аналог рецензии. Фактически, разницы между ними нет, по крайней мере, в России. И всё-таки, часто возникает расхождение в понимании этого термина, что объясняется применением его в оригинальном западном значении. К примеру, когда мы говорим о рецензии, мы имеем в виду небольшой по размеру текст, написанный на основе какого-то более крупного произведения литературного, кинематографического, музыкального характера, а также научных работ и так далее. Однако ревью может представлять собой целую книгу различных рецензий и эссе, а также глубинное исследование какого-то материала.
Пример использования слова review в названии периодического издания National Review
Ревью – как обзор
Многочисленные западные издания используют понятие ревью в значении «обзор», то есть структурированный список важных событий, произведений, объединённых каким-то единым фактором, подытоживание каких-либо аналитических работ. Это вполне закономерно, так как и у нас ревью или рецензия является обзорным материалом, значительно меньшего размера, нежели их объект. И всё-таки подобная путаница имеет продолжение. Дело в том, что кроме слова review есть ещё и overview, дословно переводящееся как обзор. Сложно? То ли ещё будет!
К видам ревью или рецензий традиционно относят:
• потребительская рецензия на товар или услугу (значение = отзыв)
• экспертная рецензия (значение = заключение)
• покупная рецензия (значение = аннотация или оплачиваемый маркетинговый ход)
Как вы можете понять, интересующие нас рецензии в списке, фактически, не значатся, за исключением первого варианта. И то, данное определение никак не объясняет, из чего же она должна состоять. Экспертная рецензия является аналогом отчёта о проведённом исследовании, а покупная – способом создать продукту определённый имидж на рынке. Специфическими становятся рецензии на произведение искусства, если те не являются непосредственным товаром: так рецензия на свободно распространяемую книгу или выложенный для скачивания в сети альбом не имеет никакого отношения к рынку, а значит, может считаться наиболее далёким от него видом рецензий.
Из чего состоит ревью?
Ревью, как и рецензия, должно содержать ряд обязательных элементов, и прежде всего, это относится к его вполне однозначной структуре. Как минимум, речь идёт о наличии вступления, содержания и заключения. Но каждый из этих пунктов предполагает деление на подуровни. Попробуем составить наиболее логичный вариант структуры рецензии или ревью.
1. Вступление:
a. интрига – часть текста, заинтересовывающая читателя,
b. объявление рассматриваемого произведения,
c. информация об авторе.
2. Содержание (центральная часть):
a. чем выделяется данное произведение?
b. характеристики важных параметров произведения (многосторонность, чувство юмора автора, стилистические особенности, качество записи и так далее),
c. положительные и отрицательные стороны (в этом пункте всегда разрешается допускать некую субъективность).
3. Заключение:
a. обобщение и анализ высказанных аргументов,
b. вынесение вердикта,
c. какой-то содержательный вывод.
Некоторые сложности может вызвать первый пункт, поэтому постараемся пояснить его на забавном примитивном примере:
«…когда он открыл глаза, вокруг ничего не было. Разве так может быть, спросите вы? В мире, созданном фантазией писателя Н., может быть практически всё. Сегодня мы ознакомимся с новой книгой мастера под названием (…)…»
Собственно, вот так и пишутся рецензии или ревью. На первый взгляд, кажется, что всё совершенно просто и логично, но читая чужие работы в сети, понимаешь, что для того, чтобы получился грамотный и интересный вашим читателям текст, нужно работать над собой, находить новые формы выражения мыслей, заинтересовывать людей, а не стараться побыстрее отделаться от этого занятия.
Что такое ревью и какова его структура?
Чтобы не кривить душой, скажем, что ревью – аналог рецензии. Фактически, разницы между ними нет, по крайней мере, в России. И всё-таки, часто возникает расхождение в понимании этого термина, что объясняется применением его в оригинальном западном значении. К примеру, когда мы говорим о рецензии, мы имеем в виду небольшой по размеру текст, написанный на основе какого-то более крупного произведения литературного, кинематографического, музыкального характера, а также научных работ и так далее. Однако ревью может представлять собой целую книгу различных рецензий и эссе, а также глубинное исследование какого-то материала.
Ревью – как обзор
Многочисленные западные издания используют понятие ревью в значении «обзор», то есть структурированный список важных событий, произведений, объединённых каким-то единым фактором, подытоживание каких-либо аналитических работ. Это вполне закономерно, так как и у нас ревью или рецензия является обзорным материалом, значительно меньшего размера, нежели их объект. И всё-таки подобная путаница имеет продолжение. Дело в том, что кроме слова review есть ещё и overview, дословно переводящееся как обзор. Сложно? То ли ещё будет!
К видам ревью или рецензий традиционно относят:
• потребительская рецензия на товар или услугу (значение = отзыв)
• экспертная рецензия (значение = заключение)
• покупная рецензия (значение = аннотация или оплачиваемый маркетинговый ход)
Как вы можете понять, интересующие нас рецензии в списке, фактически, не значатся, за исключением первого варианта. И то, данное определение никак не объясняет, из чего же она должна состоять. Экспертная рецензия является аналогом отчёта о проведённом исследовании, а покупная – способом создать продукту определённый имидж на рынке. Специфическими становятся рецензии на произведение искусства, если те не являются непосредственным товаром: так рецензия на свободно распространяемую книгу или выложенный для скачивания в сети альбом не имеет никакого отношения к рынку, а значит, может считаться наиболее далёким от него видом рецензий.
Из чего состоит ревью?
Ревью, как и рецензия, должно содержать ряд обязательных элементов, и прежде всего, это относится к его вполне однозначной структуре. Как минимум, речь идёт о наличии вступления, содержания и заключения. Но каждый из этих пунктов предполагает деление на подуровни. Попробуем составить наиболее логичный вариант структуры рецензии или ревью.
1. Вступление:
a. интрига – часть текста, заинтересовывающая читателя,
b. объявление рассматриваемого произведения,
c. информация об авторе.
2. Содержание (центральная часть):
a. чем выделяется данное произведение?
b. характеристики важных параметров произведения (многосторонность, чувство юмора автора, стилистические особенности, качество записи и так далее),
c. положительные и отрицательные стороны (в этом пункте всегда разрешается допускать некую субъективность).
3. Заключение:
a. обобщение и анализ высказанных аргументов,
b. вынесение вердикта,
c. какой-то содержательный вывод.
Некоторые сложности может вызвать первый пункт, поэтому постараемся пояснить его на забавном примитивном примере:
«…когда он открыл глаза, вокруг ничего не было. Разве так может быть, спросите вы? В мире, созданном фантазией писателя Н., может быть практически всё. Сегодня мы ознакомимся с новой книгой мастера под названием (…)…»
Собственно, вот так и пишутся рецензии или ревью. На первый взгляд, кажется, что всё совершенно просто и логично, но читая чужие работы в сети, понимаешь, что для того, чтобы получился грамотный и интересный вашим читателям текст, нужно работать над собой, находить новые формы выражения мыслей, заинтересовывать людей, а не стараться побыстрее отделаться от этого занятия.
Эффектно и эффективно. Как оценить сотрудников по методу Performance Review?
Представим себе ситуацию: сотрудник проработал в компании определенное время и хотел бы обсудить карьерные возможности. Либо руководство хотело бы проверить эффективность команды за определенный период. В таких случаях компания должна провести Performance Review сотрудника – оценить проявление профессиональных качеств в работе, эффективность выполнения задач и потенциал для продвижения по карьерной лестнице, обсудить понимание роли в команде, дать конструктивный фидбек и помочь с постановкой и достижением целей.
Именно для этого придумана практика внедрения performance review в крупных компаниях. Перфоманс ревью относится к наиболее популярным методам оценки персонала, а частота и глубина этой проверки зависит от размеров компании, а также её целей.
Метод Performance Review – что это?
Для начала определимся, с чем имеем дело: Performance Review (от англ. «обзор производительности») – это метод оценивания труда за конкретный отрезок времени, который определяет сильные и слабые стороны сотрудника, даёт обратную связь от руководства и коллег и предлагает помощь в постановке целей для будущего профессионального развития. Процесс ревью проходит тет-а-тет между менеджером и работником.
Почему этот подход так популярен?
Какие критерии учитываются при оценивании сотрудника?
На ревью оценивают корпоративные и профессиональные компетенции. При этом, рассматривают компетенции, которые непосредственно нужны для занимаемой должности, но также и так называемые soft skills: был ли он хорош в коммуникации с клиентами, самостоятельно ли решал возникающие проблемы,
смог креативно подойти к заданию, и т.д. Все это можно описать, добавить индикаторы – основные характеристики, помогающие понять, как оценить компетенцию – и получить измерение той же коммуникативности или автономности в числовом значении. И это – одно из преимуществ объективного Performance Review.
Ревью также оценивает потенциал сотрудника в рамках текущих возможностей на занимаемой должности. Как он раскрывается, проявляет себя и может ли претендовать на продвижение? Оценка потенциала важна для определения активных и вовлеченных игроков-сотрудников, которых можно воспитать внутри команды и вырастить для высоких должностей.
С другой стороны, оценивается эффективность на рабочем месте. Она нужна для вычисления самых продуктивных сотрудников, но с другой стороны помогает определить, в каком департаменте не хватает рук, чтобы справляться с задачами. Для этого необходимо проанализировать три составляющие эффективности:
Для чего нужен перфоманс ревью?
Во-первых, регулярное проведение оценки – это возможность для члена команды показать себя, проговорить с начальством личные успехи, обсудить справедливое вознаграждение в виде пересмотра зарплаты, если это уместно.
Во-вторых, метод выгоден и компании. Перфоманс ревью помогает определить сильные и слабые места в команде, отследить эффективность сотрудников и ее спад, понять, что влияет на коллектив. А линейным менеджерам такой подход нужен, чтобы обстоятельно и аргументированно влиять на карьерный путь подчиненных. Если на руках есть числовое подтверждение того, что сотрудник не справляется с обязанностями, ему намного проще объяснить это, предъявив факты и цифры. Плюсом перфоманса является его прозрачность – все открыто, оценивание проходит честно, цели и статусы задач легко отслеживаются, так что у сотрудника не остается претензий к руководству.
Каковы этапы проведения Performance Review?
Как мы уже определились, стороны в этом процессе две – менеджер и сотрудник компании. Каждый из них готовится поэтапно. Менеджеру необходимо:
Определиться с компетенциями для оценивания за период
Выбрать, какие компетенции будем оценивать, и обозначить индикаторы для оценки. Например, если мы выбираем компетенцию “Коммуникабельность”, то индикаторами высокой оценки будут желание брать на себя ответственность за общение с клиентами и коллегами, умение выстроить логичный диалог, умение убеждать и склонять клиента на свою сторону, умение расположить к себе, выслушать и т.д.
Компетенциями могут выступать:
Собрать показатели продуктивности
Провести оценку деятельности
Оценка сотрудника может проводиться по методам 180 и 360 градусов. В первом случае человек оценивает сам себя, и по таким же критериям его оценивает линейный руководитель. Во втором – подключаются еще и коллеги. На примере оценки 180 градусов рассмотрим процедуру:
Такой цикл оценки можно проводить с помощью автоматизированных программ, которые помогают создать вопросы, добавить компетенции для оценки и отправить сотрудникам опросники вовремя. К тому же, сразу после окончания цикла оценки, программа автоматически позволяет назначить итоговый 1-on-1 с менеджером.
Подготовиться к разговору с сотрудником
Перед 1-on-1 встречей руководитель должен проанализировать совпадения и отличия в результатах оценки сотрудника, просмотреть предыдущие встречи 1-on-1 и еще раз проверить, достиг ли сотрудник поставленных целей, и какие факторы могли помешать ему это сделать. Также для результативной встречи готовится предварительный план обсуждения.
Встреча с сотрудником
На встрече сотрудник и менеджер анализируют показатели за прошедший период, обсуждают оценку по компетенциям, смотрят на выполненные задачи и совместно ставят новые цели. Руководство обязательно должно проявить инициативу в расстановке приоритетов – так человеку проще будет понять, на чем сфокусироваться в первую очередь, и оценить уровень готовности. Но нередко этот момент упускают из виду – и зря. Какие же еще бывают ошибки в performance review?
Что стоит и чего не стоит делать на перформанс ревью
Ошибки при оценивании эффективности – какие бывают, и как избежать?
Первая и самая большая ошибка при проведении Performance Review, с которой сталкиваются участники процесса – преувеличение или преуменьшение своих заслуг. Так устроена психика – мы любое признание вины или ошибки принимаем как негатив, который может повлиять на отношение начальства или даже на уровень оплаты труда. Поэтому перед оценкой менеджер должен четко расставить приоритеты – всё, что будет оцениваться, рассмотрим только в контексте будущего роста в компании. Хотите развиваться? Оценивайте себя трезво и свободно принимайте критику коллектива, если она конструктивна.
Что ещё должны учитывать стороны оценивания?
Что делать после перформанс ревью?
После разговора нужно обязательно зафиксировать договоренности, которые обсудили, чтобы и у компании, и у сотрудника было одинаковое понимание ситуации. Важно прописать цели, которые совместно поставили – и обязательно наметить следующую встречу. В общем, требуется небольшой follow-up, выводы, которые высылаются сотруднику во избежание недопониманий. Иногда о нём забывают, поэтому задача менеджера – проследить за письменным подтверждением итогов беседы.
Разница между старыми методами оценки и методом перфоманс ревью
Плюсы и минусы проведения Performance Review
Общая польза от метода
Такой тип оценивания – хороший метод управления сразу результативностью, мотивацией и развитием своих подчинённых. Большим его преимуществом является оценка сотрудника сразу с нескольких сторон – самооценка, мнение коллег и мнение менеджера. А полученные графики по оцениванию и коэффициентам результативности компания может использовать для подведения промежуточных и итоговых результатов года. И, конечно, нужно помнить про особенность Performance Review – это только один из методов подсчета эффективности, но именно он помогает не потерять успехи важных для компании талантов, растить их и продвигать по карьерной лестнице.
Вот еще несколько плюсов для обеих сторон:
А есть ли минусы?
Если уж мы заговорили о рейтингах, которые влияют на итоги года и возможность попросить прибавку к окладу, нужно вспомнить, что они не всегда бывают объективны. Вот минусы оценивания:
Напрашивается вывод – работать в первую очередь над объективными показателями для составления анкет персоналу и менеджеру, который проводит оценивание.
Автоматизируем проведение ревью с помощью HRM-платформ
К инструментам проведения оценивания можно отнести:
Проблема здесь в том, что в процессе работы и подготовки к ревью даже самые кропотливые менеджеры могут забыть о каком-то пусть и незначительном нюансе, который в итоге повлияет на взаимопонимание между ним и подопечным. Как результат – ошибки в коммуникации и плохая постановка целей.
Собрать задачи воедино может платформа для HRM-задач, если она предусматривает возможность проводить ревью персонала.
Компании, которые используют метод перформанс ревью в работе
Adobe
Метод оценивания в компании Adobe используется с 2012 года, более того – компания использует процессы автоматизации, чтобы облегчить коммуникацию с работниками. За девять лет компания просчитала, что с помощью ревью сохранила более 100 тысяч рабочих часов, которые сотрудники тратили на прояснение задач или заполнение лишних брифов. Показатели по лояльности после начала использования HRM-платформ выросли на 10%.
Гигант на рынке труда Google к оцениванию сотрудников подходит очень детально – компания ввела в ревью дополнительный уровень, который получил название «калибровка». После того как менеджер составляет предварительный рейтинг по сотруднику, основываясь на шкале от «нуждается в улучшении» до «превосходит ожидания», он собирает фокус-группу, которая рассматривает индивидуальные показатели и снижает уровень субъективности рейтинга.
General Electric
Опыт проведения перформанс ревью в этой компании берет начало еще в 1979, и, по словам руководства, стал уже неким ритуалом. За столько лет компания разработала целое приложение по коммуникации с персоналом – оно помогает собирать ежедневные отзывы по рабочим процессам и даже позволяет собирать «плюшки» за активность, которые потом можно перевести в дополнительный показатель мотивации.
Применение Performance Review, по нашему скромному мнению, – один из самых комплексных способов оценки сотрудника не только количественно, но и идейно. А идея проста – помочь понять, что оценка нужна ради развития профессиональных качеств. Так что, при соблюдении всех правил игры, кто же откажется «прокачать» свои навыки и доказать, что именно он влияет на успех всей компании?