#практика
UPD: задание улетело, как горячий пирожок😉
Ну, не унывайте, ещё найдется)
Прошу минутку внимания!)
Начинающие техписы, которые бы хотели сконтрибьютить в опенсорс, отзовитесь)
Есть автор одной утилиты, который бы не отказался от помощи в написании небольшой инструкции) но сроки чуть поджимают)
Писать мне (Лиде) в личку @litulyagan
UPD: задание улетело, как горячий пирожок😉
Ну, не унывайте, ещё найдется)
Прошу минутку внимания!)
Начинающие техписы, которые бы хотели сконтрибьютить в опенсорс, отзовитесь)
Есть автор одной утилиты, который бы не отказался от помощи в написании небольшой инструкции) но сроки чуть поджимают)
Писать мне (Лиде) в личку @litulyagan
❤13
#писалитирекомендует
Всем привет!
18 апреля в 19:00 X5 Tech проведёт в Москве четвёртый Techdoc Meetup! В программе доклады на актуальные темы: использование ИИ, выстраивание процессов и даже... личных границ! А завершится всё ставшим уже традиционным круглым столом.
Мероприятие будет проведено очно. Подробности, билеты и программу митапа ищите тут ✍️
А для тех, кто не сможет присутствовать лично, будет трансляция на YouTube 🎥
Всем привет!
18 апреля в 19:00 X5 Tech проведёт в Москве четвёртый Techdoc Meetup! В программе доклады на актуальные темы: использование ИИ, выстраивание процессов и даже... личных границ! А завершится всё ставшим уже традиционным круглым столом.
Мероприятие будет проведено очно. Подробности, билеты и программу митапа ищите тут ✍️
А для тех, кто не сможет присутствовать лично, будет трансляция на YouTube 🎥
x5-tech-event.timepad.ru
Techdoc Meetup #4 / События на TimePad.ru
Приглашаем вас на Techdoc Meetup #4, который пройдет 18 апреля! Вас ждут 4 доклада: поговорим про ИИ, процессы и личные границы. Подведем итоги традиционным круглым столом.
Митап будет полезен всем техническим писателям и не только.
Митап будет полезен всем техническим писателям и не только.
🔥15✍4❤3
Техписалити!
#практика UPD: задание улетело, как горячий пирожок😉 Ну, не унывайте, ещё найдется) Прошу минутку внимания!) Начинающие техписы, которые бы хотели сконтрибьютить в опенсорс, отзовитесь) Есть автор одной утилиты, который бы не отказался от помощи в написании…
#такбывает
Всем привет!
Зафиксирован случай контрибуции техписателя в документацию опенсорсного продукта!
Недавно мы искали желающего, кто может срочно помочь разработчику. Техписатель-джун Полина Клименко согласилась помочь и написала инструкцию для утилиты mdis, которая позволяет "вытаскивать" актуальные примеры из кода.
Мы побеседовали с Полиной о её работе и попросили поделиться, на что стоит обратить внимание при работе над документацией в опенсорс.
Ответ был так хорош, что мы решили разместить беседу полностью. Приятного чтения!
А ещё это наша первая публикация в телетайп. Ставьте реакции, если формат зашёл!
Всем привет!
Зафиксирован случай контрибуции техписателя в документацию опенсорсного продукта!
Недавно мы искали желающего, кто может срочно помочь разработчику. Техписатель-джун Полина Клименко согласилась помочь и написала инструкцию для утилиты mdis, которая позволяет "вытаскивать" актуальные примеры из кода.
Мы побеседовали с Полиной о её работе и попросили поделиться, на что стоит обратить внимание при работе над документацией в опенсорс.
Ответ был так хорош, что мы решили разместить беседу полностью. Приятного чтения!
А ещё это наша первая публикация в телетайп. Ставьте реакции, если формат зашёл!
Teletype
Документация для опенсорса: 5 советов новичку
О контрибуции в опенсорс много говорят, и эта фраза часто встречается в рекомендациях начинающим техписателям. Но попробуйте спросить...
🔥37❤9👏6🏆2👍1
Всем привет!
Мы публикуем всякие полезности разного уровня, но всё-таки Техписалити! — это открытая школа техписов, и здесь мы погружаем в профессию ещё и начинающих с нуля.
Именно для таких подписчиков мы запускаем новую рубрику — #средаразработки, в которой знакомим новичков с IT-лексиконом и рассказываем, когда техписатель может с ним столкнуться.
И особое очарование в том, что #средаразработки будет выходить по средам!😉
Мы публикуем всякие полезности разного уровня, но всё-таки Техписалити! — это открытая школа техписов, и здесь мы погружаем в профессию ещё и начинающих с нуля.
Именно для таких подписчиков мы запускаем новую рубрику — #средаразработки, в которой знакомим новичков с IT-лексиконом и рассказываем, когда техписатель может с ним столкнуться.
И особое очарование в том, что #средаразработки будет выходить по средам!
Please open Telegram to view this post
VIEW IN TELEGRAM
👍22❤6🥰4🔥2👌1
Если онбординг хранится в виде документации, технический писатель может помочь составить и поддерживать его актуальность.
В онбординговых статьях обычно собирают:
📌 Первые действия, которые должен сделать новичок.
📌 Ссылки на полезные материалы — например, регламент релизов.
📌 Описание и ссылки на тестовые стенды, репозитории, метрики, чаты, а также информация, как получить к ним доступ.
Но на самом деле все онбординги вариативны и зависят от команд и их потребностей.
#средаразработки
В онбординговых статьях обычно собирают:
📌 Первые действия, которые должен сделать новичок.
📌 Ссылки на полезные материалы — например, регламент релизов.
📌 Описание и ссылки на тестовые стенды, репозитории, метрики, чаты, а также информация, как получить к ним доступ.
Но на самом деле все онбординги вариативны и зависят от команд и их потребностей.
#средаразработки
👍12🤝7❤6🔥3
Сказ о том, как три филологические девы стали техножрицами... или who is who)🧐
Всем привет!
За последнее время у нас в канале появилось много новеньких, и мы решили сделать то, что обычно делают в таких случаях - опубликовать пост-знакомство. Просим любить... ну или хотя бы не жаловаться)
Лида - технический писатель Wildberries (между прочим, первый представитель этого редкого вида в корпорации!), амбассадор WB в белгородских вузах, а также идейный вдохновитель этого канала! У нее за плечами 20 лет опыта работы с текстами, из которых 9 - в журналистике. А теперь Лида знает не только как в одиночку развернуть документацию с нуля (на минуточку, используя docs-as-code!), но и как собеседовать и нанимать техписателей. Прочитать о том, как Лида пришла в техписательство, можно здесь.
Маша - технический писатель Ozon (да-да, работа в соперничающих корпорациях дружбе не помеха!). Профессиональный редактор, мечтавший когда-то стать программистом. Под её руководством одно из крупнейших издательств страны выпускало детские книги, среди которых - крутой сборник головоломок! А сейчас Маша не только пишет внутреннюю документацию для разработчиков, но ещё придумывает новые рубрики и виртуозно создаёт большинство мемов для этого канала. О том, как Маша стала техписателем, читайте тут.
Катя - технический и UX-писатель Лаборатории Касперского. В прошлом переводчик в нефтегазовой отрасли, теперь создает пользовательскую документацию для b2c и b2b продуктов, а также работает с текстами интерфейсов (аж на целых двух языках!). В этом канале отвечает за языковое разнообразие. О карьерном пути Кати читайте здесь.
Все трое начали карьеру техписателей в одном из подразделений VK. С тех пор наши профессиональные пути немного разошлись... но мы по-прежнему вместе и пытаемся быть полезными для сообщества технических писателей и для тех, кто только собирается к нему присоединиться)
В комментариях расскажите о себе... а может даже о том, как тут оказались!✍️
P.S. А ещё нашему каналу недавно исполнился целый один год! Спасибо, что вы с нами! 🩵
Всем привет!
За последнее время у нас в канале появилось много новеньких, и мы решили сделать то, что обычно делают в таких случаях - опубликовать пост-знакомство. Просим любить... ну или хотя бы не жаловаться)
Лида - технический писатель Wildberries (между прочим, первый представитель этого редкого вида в корпорации!), амбассадор WB в белгородских вузах, а также идейный вдохновитель этого канала! У нее за плечами 20 лет опыта работы с текстами, из которых 9 - в журналистике. А теперь Лида знает не только как в одиночку развернуть документацию с нуля (на минуточку, используя docs-as-code!), но и как собеседовать и нанимать техписателей. Прочитать о том, как Лида пришла в техписательство, можно здесь.
Маша - технический писатель Ozon (да-да, работа в соперничающих корпорациях дружбе не помеха!). Профессиональный редактор, мечтавший когда-то стать программистом. Под её руководством одно из крупнейших издательств страны выпускало детские книги, среди которых - крутой сборник головоломок! А сейчас Маша не только пишет внутреннюю документацию для разработчиков, но ещё придумывает новые рубрики и виртуозно создаёт большинство мемов для этого канала. О том, как Маша стала техписателем, читайте тут.
Катя - технический и UX-писатель Лаборатории Касперского. В прошлом переводчик в нефтегазовой отрасли, теперь создает пользовательскую документацию для b2c и b2b продуктов, а также работает с текстами интерфейсов (аж на целых двух языках!). В этом канале отвечает за языковое разнообразие. О карьерном пути Кати читайте здесь.
Все трое начали карьеру техписателей в одном из подразделений VK. С тех пор наши профессиональные пути немного разошлись... но мы по-прежнему вместе и пытаемся быть полезными для сообщества технических писателей и для тех, кто только собирается к нему присоединиться)
В комментариях расскажите о себе... а может даже о том, как тут оказались!✍️
P.S. А ещё нашему каналу недавно исполнился целый один год! Спасибо, что вы с нами! 🩵
❤68👍19🎉11🍓7👏1
Если в компании используют подход Docs-as-Code, скорее всего, документация пишется и хранится в гите. Чем этот инструмент привлёк технических писателей?
📌 С документами или проектом может работать сразу несколько человек.
📌 Система хранит всю историю изменений и позволяет видеть, кто и когда их внёс, а также вернуться к любой из версий.
📌 Перед итоговой публикацией нужно получить аппрув — это могут быть как вычитывающие коллеги, так и заказчики документации.
📌 Систему можно настроить так, что править документацию сможет кто угодно, но без аппрува технического писателя на проде эти изменения не появятся.
📌 Можно создавать отдельные версии документации. Удобно, если у продукта несколько версий, но хранить статьи только новейшей версии по каким-то причинам нельзя.
Когда первый раз видишь гит, может показаться, что это что-то сложное и непонятное. Но на самом деле это только кажется. Когда немного с ним поработаешь, понимаешь, насколько это удобный и простой инструмент! Но главное — не перепутать команды😏
P.S. Мы максимально упростили описание и взяли только самые распространенные причины. Пишите в комментариях, за что вы любите или не любите гит
#средаразработки
Когда первый раз видишь гит, может показаться, что это что-то сложное и непонятное. Но на самом деле это только кажется. Когда немного с ним поработаешь, понимаешь, насколько это удобный и простой инструмент! Но главное — не перепутать команды
P.S. Мы максимально упростили описание и взяли только самые распространенные причины. Пишите в комментариях, за что вы любите или не любите гит
#средаразработки
Please open Telegram to view this post
VIEW IN TELEGRAM
👍23❤4🔥3✍2🤔2❤🔥1
#практика
Целевая аудитория: начинающие
Всем привет! Ну что, новички, соскучились по домашке?
Сегодня мы познакомимся с важным инструментом — системой контроля версий на примере GitHub.
😉 Git для самых маленьких
Для чего нужен гит? Если коротко, то в гите вся команда может работать над проектом одновременно, отслеживать все изменения и возвращаться к любой его версии.
Самая крупная сущность в гите — это репозиторий. Выглядит как главная, корневая папка со множеством папок и файлов внутри. Например, как наш крохотный учебный репозиторий.
Но это не простая папка, а золотая. Для того, чтобы работать в гите, начинающему техписателю нужно немного переформатировать сознание. Как — расскажем в следующих занятиях.😊
А пока предлагаем выполнить простое задание — зарегистрироваться на GitHub, кто ещё не)
Как это сделать? А вот тут примените навыки техписателя: умение находить информацию в свободном доступе и разбираться в чём-то самостоятельно.
Потом мы вместе отправимся знакомиться с гитом, шаг за шагом.
Как вам наша идея? Накидайте реакций или оставьте комментарии➕
Целевая аудитория: начинающие
Всем привет! Ну что, новички, соскучились по домашке?
Сегодня мы познакомимся с важным инструментом — системой контроля версий на примере GitHub.
Для чего нужен гит? Если коротко, то в гите вся команда может работать над проектом одновременно, отслеживать все изменения и возвращаться к любой его версии.
Самая крупная сущность в гите — это репозиторий. Выглядит как главная, корневая папка со множеством папок и файлов внутри. Например, как наш крохотный учебный репозиторий.
Но это не простая папка
А пока предлагаем выполнить простое задание — зарегистрироваться на GitHub, кто ещё не)
Как это сделать? А вот тут примените навыки техписателя: умение находить информацию в свободном доступе и разбираться в чём-то самостоятельно.
Потом мы вместе отправимся знакомиться с гитом, шаг за шагом.
Как вам наша идея? Накидайте реакций или оставьте комментарии
Please open Telegram to view this post
VIEW IN TELEGRAM
🔥45👍13💘6❤2✍2
Всем привет, на связи Маша 👋
Сегодня ещё один особенный день для канала — без двух дней год, как мы запустили рубрику #мемница. Рубрика выходила каждую пятницу, не считая праздничных, поэтому мы чуть-чуть не дотянули до 50 мемов🙂
Как вы знаете (или не знаете), все наши мемы — авторские, а большую их часть сочиняю я. Как истинный творец, делаю это по ночам и кидаю коллегам-по-каналу на оценку. Лида любит называть эти ночи как «Город засыпает, просыпается Маша».
Иногда у меня случаются «творческие кризисы» и я готова сообщать, что рубрика закрывается. Но потом какой-нибудь неожиданный мем вызывает у вас сильный отклик, и это очень вдохновляет! Например, прошлый мем очень неожиданно для меня набрал больше ста реакций, я до сих не понимаю, как так вышло... Но после такого думаю и надеюсь, что всё не зря.
Спасибо вам за ваши реакты и комментарии!💖
Сегодня ещё один особенный день для канала — без двух дней год, как мы запустили рубрику #мемница. Рубрика выходила каждую пятницу, не считая праздничных, поэтому мы чуть-чуть не дотянули до 50 мемов
Как вы знаете (или не знаете), все наши мемы — авторские, а большую их часть сочиняю я. Как истинный творец, делаю это по ночам и кидаю коллегам-по-каналу на оценку. Лида любит называть эти ночи как «Город засыпает, просыпается Маша».
Иногда у меня случаются «творческие кризисы» и я готова сообщать, что рубрика закрывается. Но потом какой-нибудь неожиданный мем вызывает у вас сильный отклик, и это очень вдохновляет! Например, прошлый мем очень неожиданно для меня набрал больше ста реакций, я до сих не понимаю, как так вышло... Но после такого думаю и надеюсь, что всё не зря.
Спасибо вам за ваши реакты и комментарии!
Please open Telegram to view this post
VIEW IN TELEGRAM
❤🔥25🔥10❤5🏆3
#практика
Целевая аудитория: начинающие
Сегодня мы продолжаем разговор про Git для самых маленьких:
🌿Ветки и форки
Мы уже говорили о том, что гит позволяет всей команде одновременно работать над проектом, изменять одни и те же файлы. Сделать это можно благодаря веткам или форкам (в GitHub).
🧐 - Непонятно. То есть есть репозиторий и от него ветки?
Основной репозиторий — это тоже ветка, только ветка основная. Чаще всего её называют master (в комментариях Кот напомнил, что в гитхабе теперь main). Гит позволяет считать основной любую ветку в репозитории, независимо от названия. Участник команды создаёт свою ветку от ветки master.
🤫 - А если я создам много веток, это у нас быстро место на сервере закончится?
Визуально ветка выглядит как копия репозитория. Но на самом деле это не копии: ветки отображают содержимое репозитория, а не содержат его. Поэтому ветки весят ничтожно мало, занимают ничтожно маленький объём памяти, и поэтому веток можно создавать очень-очень большое количество. Ветки создаются в том же репозитории.
Форки - это копии репозиториев, они сохраняют и содержимое исходного репозитория, и его настройки. Часто форки создают, когда команда распадается, например, на части, и все хотят развивать продукт по-своему. С помощью форка можно дорабатывать открытое ПО.
😏 - Понятно. Но как же все изменения собирают вместе?
И ветку, и форк, точнее, изменения в них, можно слить в ветку master. Для этого создают запрос на слияние — merge request или pull request. Владелец репозитория или сеньор, отвечающий за мерж\пулл реквест, рассматривает запрос, а затем принимает или отклоняет его.
🫡 А теперь задание:
Если вы уже выполнили предыдущее задание - зарегистрировались в GitHub, сделайте форк нашего учебного проекта. Ну и конечно же, накидайте реакций)
Целевая аудитория: начинающие
Сегодня мы продолжаем разговор про Git для самых маленьких:
🌿Ветки и форки
Мы уже говорили о том, что гит позволяет всей команде одновременно работать над проектом, изменять одни и те же файлы. Сделать это можно благодаря веткам или форкам (в GitHub).
Основной репозиторий — это тоже ветка, только ветка основная. Чаще всего её называют master (в комментариях Кот напомнил, что в гитхабе теперь main). Гит позволяет считать основной любую ветку в репозитории, независимо от названия. Участник команды создаёт свою ветку от ветки master.
Визуально ветка выглядит как копия репозитория. Но на самом деле это не копии: ветки отображают содержимое репозитория, а не содержат его. Поэтому ветки весят ничтожно мало, занимают ничтожно маленький объём памяти, и поэтому веток можно создавать очень-очень большое количество. Ветки создаются в том же репозитории.
Форки - это копии репозиториев, они сохраняют и содержимое исходного репозитория, и его настройки. Часто форки создают, когда команда распадается, например, на части, и все хотят развивать продукт по-своему. С помощью форка можно дорабатывать открытое ПО.
И ветку, и форк, точнее, изменения в них, можно слить в ветку master. Для этого создают запрос на слияние — merge request или pull request. Владелец репозитория или сеньор, отвечающий за мерж\пулл реквест, рассматривает запрос, а затем принимает или отклоняет его.
Если вы уже выполнили предыдущее задание - зарегистрировались в GitHub, сделайте форк нашего учебного проекта. Ну и конечно же, накидайте реакций)
Please open Telegram to view this post
VIEW IN TELEGRAM
🔥25✍6❤4👍1
#коллаборалити #анонс
Всем привет!
Мы нашли способ сделать знакомство с Git ещё лучше. И в этом нам помогут Лена, Саша и канал quizzes4fun!
Ребята с этого понедельника (10 июня) запустили свою Неделю гита. В постах и квизах они рассказывают про гит и всякие его фишки. Начинающим можно узнать новое, а опытным — проверить свои знания.
😏 Рекомендуем)
Всем привет!
Мы нашли способ сделать знакомство с Git ещё лучше. И в этом нам помогут Лена, Саша и канал quizzes4fun!
Ребята с этого понедельника (10 июня) запустили свою Неделю гита. В постах и квизах они рассказывают про гит и всякие его фишки. Начинающим можно узнать новое, а опытным — проверить свои знания.
Please open Telegram to view this post
VIEW IN TELEGRAM
Telegram
quizzes4fun
Причины перехода на систему контроля версий на проекте
🐞 Система контроля версий фиксирует изменения.
Фиксация истории проекта может быть полезна во многих аспектах. Но чаще всего ее удобно использовать для поддержки версионирования и восстановления или…
🐞 Система контроля версий фиксирует изменения.
Фиксация истории проекта может быть полезна во многих аспектах. Но чаще всего ее удобно использовать для поддержки версионирования и восстановления или…
🔥18👍8❤6👨💻2
Всем привет 👋
Сегодня мы с вакансией в Ozon!
В команду технических писателей департамента «Поиск, рекомендации, реклама» ищем техписа, который будет писать внутреннюю документацию в Confluenceи иногда клепать мемы.
Мы делаем доки про ML-модели, факторы ранжирования, алгоритмы рекомендаций, архитектуру поиска в Ozon и всякое другое.
🌩 Почитать подробнее и откликнуться можно на Ozon Job или HH
#вакансия
Сегодня мы с вакансией в Ozon!
В команду технических писателей департамента «Поиск, рекомендации, реклама» ищем техписа, который будет писать внутреннюю документацию в Confluence
Мы делаем доки про ML-модели, факторы ранжирования, алгоритмы рекомендаций, архитектуру поиска в Ozon и всякое другое.
#вакансия
Please open Telegram to view this post
VIEW IN TELEGRAM
🔥20❤7👌4👏1💯1