Если в компании используют подход Docs-as-Code, скорее всего, документация пишется и хранится в гите. Чем этот инструмент привлёк технических писателей?

📌С документами или проектом может работать сразу несколько человек.
📌Система хранит всю историю изменений и позволяет видеть, кто и когда их внёс, а также вернуться к любой из версий.
📌Перед итоговой публикацией нужно получить аппрув — это могут быть как вычитывающие коллеги, так и заказчики документации.
📌Систему можно настроить так, что править документацию сможет кто угодно, но без аппрува технического писателя на проде эти изменения не появятся.
📌Можно создавать отдельные версии документации. Удобно, если у продукта несколько версий, но хранить статьи только новейшей версии по каким-то причинам нельзя.

Когда первый раз видишь гит, может показаться, что это что-то сложное и непонятное. Но на самом деле это только кажется. Когда немного с ним поработаешь, понимаешь, насколько это удобный и простой инструмент! Но главное — не перепутать команды 😏

P.S. Мы максимально упростили описание и взяли только самые распространенные причины. Пишите в комментариях, за что вы любите или не любите гит

#средаразработки

#практика
Целевая аудитория: начинающие

Всем привет! Ну что, новички, соскучились по домашке?
Сегодня мы познакомимся с важным инструментом — системой контроля версий на примере GitHub.

😉 Git для самых маленьких

Для чего нужен гит? Если коротко, то в гите вся команда может работать над проектом одновременно, отслеживать все изменения и возвращаться к любой его версии.

Самая крупная сущность в гите — это репозиторий. Выглядит как главная, корневая папка со множеством папок и файлов внутри. Например, как наш крохотный учебный репозиторий.

Но это не простая папка, а золотая. Для того, чтобы работать в гите, начинающему техписателю нужно немного переформатировать сознание. Как — расскажем в следующих занятиях.😊

А пока предлагаем выполнить простое задание — зарегистрироваться на GitHub, кто ещё не)
Как это сделать? А вот тут примените навыки техписателя: умение находить информацию в свободном доступе и разбираться в чём-то самостоятельно.

Потом мы вместе отправимся знакомиться с гитом, шаг за шагом.

Как вам наша идея? Накидайте реакций или оставьте комментарии➕

Всем привет, на связи Маша 👋

Сегодня ещё один особенный день для канала — без двух дней год, как мы запустили рубрику #мемница. Рубрика выходила каждую пятницу, не считая праздничных, поэтому мы чуть-чуть не дотянули до 50 мемов 🙂

Как вы знаете (или не знаете), все наши мемы — авторские, а большую их часть сочиняю я. Как истинный творец, делаю это по ночам и кидаю коллегам-по-каналу на оценку. Лида любит называть эти ночи как «Город засыпает, просыпается Маша».

Иногда у меня случаются «творческие кризисы» и я готова сообщать, что рубрика закрывается. Но потом какой-нибудь неожиданный мем вызывает у вас сильный отклик, и это очень вдохновляет! Например, прошлый мем очень неожиданно для меня набрал больше ста реакций, я до сих не понимаю, как так вышло... Но после такого думаю и надеюсь, что всё не зря.

Спасибо вам за ваши реакты и комментарии! 💖

#практика
Целевая аудитория: начинающие

Сегодня мы продолжаем разговор про Git для самых маленьких:

🌿Ветки и форки

Мы уже говорили о том, что гит позволяет всей команде одновременно работать над проектом, изменять одни и те же файлы. Сделать это можно благодаря веткам или форкам (в GitHub).

🧐 - Непонятно. То есть есть репозиторий и от него ветки?

Основной репозиторий — это тоже ветка, только ветка основная. Чаще всего её называют master (в комментариях Кот напомнил, что в гитхабе теперь main). Гит позволяет считать основной любую ветку в репозитории, независимо от названия. Участник команды создаёт свою ветку от ветки master.

🤫 - А если я создам много веток, это у нас быстро место на сервере закончится?

Визуально ветка выглядит как копия репозитория. Но на самом деле это не копии: ветки отображают содержимое репозитория, а не содержат его. Поэтому ветки весят ничтожно мало, занимают ничтожно маленький объём памяти, и поэтому веток можно создавать очень-очень большое количество. Ветки создаются в том же репозитории.

Форки - это копии репозиториев, они сохраняют и содержимое исходного репозитория, и его настройки. Часто форки создают, когда команда распадается, например, на части, и все хотят развивать продукт по-своему. С помощью форка можно дорабатывать открытое ПО.

😏 - Понятно. Но как же все изменения собирают вместе?

И ветку, и форк, точнее, изменения в них, можно слить в ветку master. Для этого создают запрос на слияние — merge request или pull request. Владелец репозитория или сеньор, отвечающий за мерж\пулл реквест, рассматривает запрос, а затем принимает или отклоняет его.

🫡 А теперь задание:
Если вы уже выполнили предыдущее задание - зарегистрировались в GitHub, сделайте форк нашего учебного проекта. Ну и конечно же, накидайте реакций)

#коллаборалити #анонс

Всем привет!
Мы нашли способ сделать знакомство с Git ещё лучше. И в этом нам помогут Лена, Саша и канал quizzes4fun!

Ребята с этого понедельника (10 июня) запустили свою Неделю гита. В постах и квизах они рассказывают про гит и всякие его фишки. Начинающим можно узнать новое, а опытным — проверить свои знания.

😏 Рекомендуем)

Всем привет 👋

Сегодня мы с вакансией в Ozon!

В команду технических писателей департамента «Поиск, рекомендации, реклама» ищем техписа, который будет писать внутреннюю документацию в Confluence и иногда клепать мемы.

Мы делаем доки про ML-модели, факторы ранжирования, алгоритмы рекомендаций, архитектуру поиска в Ozon и всякое другое.

🌩 Почитать подробнее и откликнуться можно на Ozon Job или HH

#вакансия

Привет!

Наверняка вы слышали ироничную фразу «технических писателей не существует». Как говорится, в каждой шутке — доля шутки. Давайте поговорим о том, как повысить свою видимость, когда вы только вышли на новую работу.

На самом деле «невидимость» техписов боль многих компаний, в которых сотрудники не знают, кто такие технические писатели, чем они занимаются, с чем к ним можно прийти. Ну или они и правда не знают о нашем существовании, но это уже другая история... 😅

С непониманием, что вы за покемон, можно столкнуться, например, если вы первый технический писатель в компании. Пришли со стороны или «доросли» — это уже не имеет значения.

Давайте разбираться, как можно повысить свою «видимость» в компании.

Самый банальный и простой способ — знакомиться со всеми, кто может вам помочь. Но как же узнать, с кем нужно водить знакомства?

Во-первых, вас кто-то нанимал. У этого кого-то должно быть представление о том, какие задачи вам ставить. Узнайте, что от вас ожидают: какой продукт, проект или тип документации от вас хотят в итоге увидеть. Во-вторых, вас могут «посадить» в какой-то продукт, у которого будет руководитель. Возможно, он и поможет вам сориентироваться.

Далее выбирайте наиболее «безболезненный» для вас вариант и действуйте:

💜Идите ко всем, с кем в теории будете общаться, в личку и напишите пару строк о себе и будущей работе. Можете сделать сообщение-костяк (или шаблонное, но это не очень) и отправлять его. Этот вариант подразумевает, что вы очень общительный и активный человек, который сразу выстраивает рабочие отношения. Подходит, естественно, не всем :)
🔴Прийдите к лидам продуктов или команд, с которыми вы будете работать. Познакомьтесь с ними и попросите познакомить себя с командой. Либо в общем чате, на командной встрече — буквально забежать на пару минут, например, на дейлик, планирование спринтов или ретро.
🟡Напишите сами в общекомандный чат о себе и чем можете быть полезны. Это самый простой вариант и не всегда действующий — вас увидят и забудут. А если вас представит лид или вы ворвётесь в личку к каждому — тут впечатлений будет побольше.

Про впечатления: однажды я пришла в новую компанию и меня представили в общем чате. После этого ко мне в личку пришёл лид одной из команд, чтобы познакомиться. Запомнила ли я такое поведение? Конечно! Сталкивалась ли я с этим лидом по работе? Нет! Зато его точно запомнила ☕️

Наша профессия и так часто «невидима», поэтому не стесняйтесь заходить с ноги сразу обозначать себя и вашу работу. Легко не будет, но некоторый положительный эффект всё же возможен.

А если у вас есть какие-то лайфхаки о том, как повышать свою видимость, когда вы только устроились в новую компанию — пишите в комментариях

#Выпуск 13

Всем привет, на связи Маша 👋

На новой работе иногда бывает трудно въехать в происходящее: можно потеряться в потоке информации, запутаться в процессах, стесняться задавать вопросы и много чего ещё.

Чтобы новичкам было легче жить, за ними закрепляют наставника, которым часто выступает руководитель. И вот вроде бы начало — самое время для «глупых вопросов», но новичок и так стрессует, так ещё и вопросы нужно задавать руководителю. В общем, стресс только растёт.

Как помочь новичку поскорее влиться в работу? Например, можно заранее собрать страницу с командными с процессами, инструментами и инструкциями по получению доступов. И давать ссылку на такую страницу всем новеньким! Звучит классно, но это же надо придумывать структуру, ничего не забыть...

Чтобы не задаваться лишними вопросами, мы с коллегами разработали шаблон для командных онбордингов! В целом, если вы техпис — вы можете и сами разработать, но если у вас на это нет времени, можете воспользоваться нашим 😉

Хочу представить свою статью (моя первая!) на хабре об онбординге для команд. Там я рассказываю, какая у нас была задача, как мы её решали и к чему пришли. Там же лежит и сам шаблон онбординга, который вы можете забрать. Ну и парочка мемов, куда же без них 😅

Мой любимый мем в статье — со Шреком, он с двойным смыслом! Кто не понял, тот поймёт, как говорится)

https://habr.com/ru/companies/ozontech/articles/830842/

P.S.: если вам понравилась статья или шаблон, поставьте 1️⃣ на Хабре 🙈

#колонкаредактора