Все, что необходимо вам и вашей компании, чтобы ваш новый товарищ по команде мог приступить к работе как можно скорее.
Работа инженера-программиста сейчас одна из самых популярных на планете. Он хорошо платит, его можно делать везде, и это может делать каждый. Как видно из этой статьи, с каждым годом людей, работающих программистами, постоянно увеличивается.
Но то, что люди, которые хотят стать программистами, высокого, не означает, что компания может легко найти или найти нового человека для работы на них. Они (компания) хотят найти лучшего кандидата, который преуспевает в своих навыках, способен работать в их рабочей среде, и а также тех, кто сможет приступить к работе как можно скорее.
Первые два уже упомянутых условия могут быть определены в процессе собеседования, но как насчет последнего? Как компания может привлечь нового сотрудника, чтобы как можно скорее приступить к работе? Ключ находится в сеансе подключения, особенно в документации.
Вот несколько моих мыслей, которые, как я думаю, помогут компании улучшить документацию по адаптации, чтобы их новый член команды мог приступить к работе в кратчайшие сроки. насколько возможно.
Инструменты и применение
У каждой команды программистов должен быть собственный набор инструментов, которые они используют. Новый участник не всегда использует те же инструменты и приложения, что и компания. Если они не знают, какое приложение использует компания, как они могут начать свою работу? Поэтому убедитесь, что в регистрационном документе есть:
Название приложения с версией
Имя является абсолютно обязательным, но не забывайте версию, потому что иногда поведение приложения различается в зависимости от версии.
Функция приложения
Указание функции приложения может быть очень полезным для новичка или кого-то новичка, получившего работу инженера-программиста. Это может сократить время на поиск в Google функций того или иного приложения.
Конфигурация программного обеспечения
Как новые участники, они не будут знать о конфигурации приложения, которое они будут использовать позже. Даже если коллега может рассказать им об этом позже, когда новые участники будут работать над определенным проектом, в документации по адаптации все равно необходимо сообщить об этом, чтобы новые участники могли снизить вероятность беспокойства другие сотрудники.
Разрешение на заявку
Некоторые приложения бесплатны и могут использоваться напрямую без какого-либо разрешения или лицензии, но в документации необходимо сообщать о том, как новые участники запрашивают разрешение или лицензию для конкретного приложения.
Архитектура продукта
Люди, которые работают программистами, в большинстве своем обладают большим любопытством. Даже если они работают в большой компании и вероятность того, что они коснутся (взаимодействуют) со всем продуктом, невелика, новые участники будут с большим энтузиазмом работать, если они будут знать, насколько велика их новая работа. . Есть только 2 вещи, которые, как мне кажется, необходимо записать в документации по адаптации, а именно:
Связь
Это становится обязательным, если компания уже внедряет микросервисы. Новые участники должны знать, с какими службами они будут взаимодействовать каждый день. Спросить другого сотрудника о соединении между каждой службой может стать долгим разговором, и на это может уйти много времени. Если в документе о подключении уже говорится о подключении служб, это может сократить время обсуждения, когда новый участник обращается к другому коллеге (потому что этого нельзя избежать).
Зависимости
Это соотносится с предыдущим пунктом (связью). Практически невозможно, чтобы продукт не использовал какую-либо внешнюю службу (или приложение), чтобы иметь возможность работать должным образом. Например, если серверная служба использует несколько баз данных, укажите это в документации по подключению.
Код приложения
Инженер-программист пишет коды, поэтому это самое важное, что должно быть в документации по адаптации. В документе не обязательно рассказывать все о коде внутри компании, потому что он может стать очень длинным и, конечно же, не будет прочитан новыми участниками, но вот 3 вещи я думаю, это необходимая информация, которая должна быть записана в документации.
Код и структура файла
Когда новый участник хочет написать код внутри кодовой базы компании, первое, что он имеет в виду, это:
«Куда мне поместить свой код и файл?»
Я знаю, что на этот вопрос можно ответить в процессе проверки кода, но если в документации уже есть информация об этом, процесс проверки может стать короче и может быть сосредоточен на сам код (вроде логики).
Стиль письма
Новичок, особенно опытный, должен иметь собственный стиль письма, особенно если у языка программирования нет своего стандарта. В документации по адаптации должна содержаться информация о том, что необходимо сделать и чего следует избегать, чтобы следовать стандартам компании.
Как внести свой вклад
Последнее, что нужно сделать после того, как новый участник завершит свою работу, ему нужно загрузить свои изменения в репозиторий компании. Для этого им необходимо знать, как они могут внести свой вклад, а это значит, что в адаптационном документе должна быть указана именно эта информация. Например, если компания использует Git, документ должен содержать информацию о стандарте сообщения о фиксации, стандарте названия филиала и о том, как задать вопрос другим коллегам, чтобы проверять их работу.
Развертывание приложений
Продукт компании не будет выпущен, если код, написанный инженером-программистом, не будет развернут. Иногда, особенно в компании малого и среднего бизнеса, программисту необходимо самостоятельно кодировать, а также внедрять изменения. Мы знаем, что эта информация будет очень длинной, если подробности указаны в документации по адаптации, но убедитесь, что в документе не пропущены эти две вещи.
Как внедрить изменения
Когда процесс проверки кода нового участника будет завершен, код будет объединен с кодовой базой компании. «Готово?», «Успешно ли развернуты мои изменения?» - вот некоторые вопросы, которые возникают у нового участника после объединения первого кода. Напишите информацию о том, как выполняется процесс развертывания, когда он начинается и какие инструменты используются при развертывании.
Как проверить журнал приложения
Чтобы убедиться, что новые участники будут знать, успешно ли их код развернут и работает должным образом, в документации для подключения должна быть информация о том, как получить доступ к журналу приложения. Это может помешать новым участникам часто спрашивать о последних изменениях в приложении.
Частая ошибка продукта
Предполагается, что этого никогда не произойдет, но если в продукте компании есть ошибки, которые еще не исправлены, в документации необходимо сообщить об этом новым участникам. Напишите простую заметку о том, как обрабатывать ошибки, если иногда в будущем новому участнику потребуется обработать конкретную ошибку.
Поведение команды
Это последнее, что необходимо для ознакомительной документации. Каждый новый участник присоединится к определенной команде, о которой он не знает. Хотя эту информацию можно получить позже при выполнении работы, это может подготовить нового сотрудника к началу работы в команде.
Как «работает» сделано
В документации должна быть информация о том, когда группа начинает рабочий день, какие рамки использует команда, какие ритуалы команда обычно делает, и все, что связано с тем, как новый участник будет работать с определенной командой.
С какими людьми нужно связаться
У них, как у новичков, будет много вопросов. Убедитесь, что в документации есть информация о том, с кем может связаться новый участник. Небольшое примечание: убедитесь, что человек, которому написано имя, уже проинформирован, чтобы его не смущало, если с ним свяжется новый участник.
Правила
Я думаю, это не требует пояснений. В документации должны быть прописаны правила компании и команды, частью которой станет новый участник. Запишите это как можно яснее, чтобы и компания, и новый участник могли понять, что нужно и нельзя.
Вот и все. Это мои советы, основанные на моем собственном опыте и окружающих меня лицах по документации для подключения. Я надеюсь, что эта история поможет вам и вашей компании, когда в компанию приходят новые сотрудники.
Будьте счастливы и здоровы всем!
