Parawriter – Telegram
Parawriter
947 subscribers
114 photos
3 videos
1 file
68 links
Канал технического писателя о текстах, работе в айти и ещё о чём-нибудь
———
Сотрудничество @novillero
———
Курс «Docs as code для самых маленьких»: https://news.1rj.ru/str/parawriter/119
Download Telegram
Как стать культистом? 😵‍💫

Очень просто. Глазом не успеваешь моргнуть — а ты уже последователь какого-нибудь культа.

Ой, простите, забыл повесить дисклеймер — речь идёт о карго-культах, разумеется.

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

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

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

Умная мысль застала меня в тот самый момент, когда я собирался применить этот шаблон в очередной раз. Я смотрел на него и думал: а почему этот шаблон оформлен такой странной разметкой? Зачем у этих ссылок столько отступов, зачем тут эти подчёркивания и для чего в маркдаун-файле эти html-теги?

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

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

Теперь слежу за собой вдвое внимательнее, чтобы ненароком не записаться в айти-сектанты 😇

#практика
👍26🔥10👀94😁1
Четыре года я на полной удалёнке. Гибкое планирование рабочего времени, мягкие переработки, домашний уют и экономия на бизнес-ланчах. В общем, много плюсов, и я быстро привык к хорошему.

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

Пишу этот пост из офиса, куда приехал на пару дней поработать и встретиться с ребятами из своей команды.

Всё-таки стоит признать, в этом что-то есть. Особенно если офис с бесплатными обедами и возможностью комфортно устроиться в кресле-качалке)

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

А вам где больше нравится работать, в офисе или дома?

#флуд
48💯72
Сегодня рубрика беспощадный #ux неожиданно объединяется с полезным контентом, редкий случай!

В зале, куда я хожу, решили обновить информационные таблички: сделать их более стильными и крутыми.

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

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

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

Если интересно, вы можете почитать в интернете о цветовом круге Иттена и о том, как с ним работать. Но я пошёл по простому пути и пользуюсь цветовым кругом онлайн: достаточно выбрать основной цвет, а гармоничные сочетания сгенерируются автоматически.

В общем, очередной рекомендасьон, особенно для ситуативных дизайнеров типа меня и администраторов тренажёрки 💪

#инструменты
32👍20🔥11
Когда игрался с ИИ и проиграл

Нейросети ворвались в нашу повседневную жизнь и соблазняют нас экономить свои время и деньги.

Да-да! Зачем платить дизайнеру за логотип или афишу, если можно просто сгенерировать картинку? (Кстати, космонавт с карандашом — тоже ии). Зачем нанимать копирайтера, когда дипсик напишет тебе «экспертную» статью на любую тему?

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

Многие сейчас пытаются определить, написан ли текст искусственным интеллектом, в интернете существуют целые списки примет, по которым можно определить нейросеть. Забавно, но некоторые параметры указывают на то, что парарайтер — это тоже нейросеть)

Я сам отношусь к нейросетям спокойно и специально не выискиваю их след в публикациях. Ведь если текст действительно хорош, то так ли важно, помогал ли автору ИИ? А если текст плох, то так ли важно, кто именно его написал: человек или робот?

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

Поэтому я выбрал для себя путь осознанного использования ИИ: все посты на этом канале написаны мной, несмотря на длинные тире, маркированные списки и прочие маркеры нейросети.

Напиши: "Пришли мне этот текст в формате для телеграм" — и я пришлю тебе оформленный пост. Ты в одном шаге от хорошей публикации 💪

#флуд #карьера
😁279🤔6💯4🔥2
Привет!

Год назад мы проводили большой мастер-класс «Docs as Code для самых маленьких», где целый месяц знакомились с инструментами и практиками подхода.

Мастер-класс актуален, и его можно пройти в любой момент на канале в одном из закреплённых сообщений.

А я тем временем задумался: не замахнуться ли нам на что-то посерьёзнее? Так появилась идея продолжения — расширенный курс «Docs as Code для ребят постарше».

Это будет большой мастер-класс по погружению в концепцию docs as code и получению базовых навыков владения инструментами. Мы научимся работать с git на уровне уверенного в себе технического писателя, познакомимся с языками разметки и особенно с маркдауном, освоим генератор статических сайтов MkDocs, научимся пользоваться гитхабом и публиковаться на githab pages. В общем, повторим путь первого курса, только пройдём его вместе, основательнее погрузимся в контекст и создадим не просто пример док.портала, а заложим основу в ваше будущее портфолио.

Что будет на курсе?

– 5 тематических вебинаров;
– 6 домашних заданий с проверкой и обратной связью;
– дополнительные материалы для изучения;
– много практической работы.

Мы не просто развернём сайт, но научимся публиковать на нём разные типы документации, проводить ревью и решать конфликты с коллегами.

Где?

Курс будет проходить в онлайн-формате: живые вебинары, которые можно смотреть в записи, общение в телеграм-группе, разбор домашних работ в личке и пулл-реквестах в гитхабе.

Когда?

19 января – 15 февраля 2026 года, точные даты скорректируем чуть позже)

Как записаться?

Если вы хотите принять участие в нашем супер-мастер-классе, пожалуйста, напишите @novillero

Укажите ваши имя и фамилию, а также кратко опишите ваш опыт взаимодействия с docs as code


Сколько это стоит?

Цена участия в мастер-классе — примерно 40 капучино в моей любимой кофейне) Точную стоимость вы получите в ответном сообщении на вашу заявку.

⚠️ Не верьте мошенникам

Будьте внимательны!

❗️ Мы не пишем вам первыми в личные сообщения с предложением принять участие в мастер-классе;
❗️Мы не просим вас переводить деньги куда бы то ни было;
❗️Мы не требуем оплатить бронь на место в группе или сделать любые другие платежи «очень срочно, прямо сейчас».

Если кто-то делает это от нашего имени — не верьте ему, это не настоящий парарайтер!

У нас есть только один контакт в телеграме: @novillero


А как тогда оплатить курс?

Оплатить участие в мастер-классе можно будет в течение января 2026 по выставленному счёту, который каждый участник получит в ответном сообщении в телеграме от @novillero

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

#карьера #docsascode
Please open Telegram to view this post
VIEW IN TELEGRAM
🔥1713👍2🕊1
Parawriter
Привет! Год назад мы проводили большой мастер-класс «Docs as Code для самых маленьких», где целый месяц знакомились с инструментами и практиками подхода. Мастер-класс актуален, и его можно пройти в любой момент на канале в одном из закреплённых сообщений.…
Всем привет!
Ребят, осталось три места на январский курс по docs as code.
Если вы хотите принять участие, пишите @novillero

Если мы наберём две группы, то проведём два больших мастер-класса подряд: в январе-феврале и в марте-апреле.

Всем хорошего понедельника!

UPD: Все места заняты! Пишите @novillero, добавлю вас в лист ожидания и в список второго потока)

#карьера #docsascode
👏6🔥3👀2
🎄А вот и декабрь: наступает время предпраздничной суеты, выбора подарков, планирования зимних каникул, весёлых новогодних корпоративов. Всё чаще звучат фразы типа: «Разберёмся с этим в январе», «Перенесём задачу на следующий спринт», «Решим в первом квартале 2026».

А у вас есть такие коллеги, которые невзирая на конец года приступают к реализации какого-нибудь большого и красивого проекта? Если есть, возможно вы работаете со мной) Потому что сейчас на работе я занимаюсь именно таким проектом, стараясь как можно больше успеть сделать до наступления праздников.

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

А пока анонс: по нашей доброй традиции мы проведём весёлый рождественско-новогодний розыгрыш от парарайтера! Можно будет выиграть прекрасный приз 🎁 Все подробности чуть позже, сейчас мне пора возвращаться в мои рабочие декабрьские дела 🫠 Всем хорошей и продуктивной недели!

P.S. Когда-нибудь, когда-нибудь я научусь планировать своё время так, чтобы всё успевать, но давайте перенесём это на первый квартал 2026 🙃
34🤝4😁2👀1
Сегодня отмечаем неочевидный праздник — двести тридцать пятый пост на канале!

Ладно, ладно, мне просто захотелось придумать повод, чтобы пофлудить. Всё-таки пятница, напряженный рабочий процесс на фоне — можно немного расслабиться)

На канале Техписалити! есть рубрика «Мемница» с разными забавными техписательскими мемами. Я решил перехватить идею😁

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

В общем, первый и единственный раз встречайте новую нерегулярную рубрику Техписательские (и не только) мемы от парарайтера!

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

Хорошей пятницы и прекрасных выходных!

#флуд
Please open Telegram to view this post
VIEW IN TELEGRAM
Please open Telegram to view this post
VIEW IN TELEGRAM
38🔥7😁4🤣1
Привет!

Я посмотрел на свои часы и понял — время пришло 🕰

Пришло время объявить новогодний розыгрыш от парарайтера!

В этом году Дед Мороз принесёт в подарок бесплатное участие в первом потоке большого мастер-класса «Docs as Code для ребят постарше»!

Здорово, правда? Всё, что вам нужно — подписаться на канал Parawriter и оставить любой комментарий под этой записью до 23:59 мск 24 декабря. Количество комментов значения не имеет.

25 декабря мы запустим наш прекрасный рандомайзер и выберем победителя! 🎆

Участвовать могут все желающие, даже если вы уже в списке участников мастер-класса или в листе ожидания (особенно если вы в листе ожидания))

P.S. Подарок от Деда Мороза — как лекарство из аптеки: обмену и возврату не подлежит 🤗
Поэтому надеюсь, что все, кто оставит свой конкурсный комментарий, в случае выигрыша будут рады принять участие в мастер-классе)

И пусть вам повезёт! 🕊

#docsascode #флуд
Please open Telegram to view this post
VIEW IN TELEGRAM
25👍2
Семь раз отмерь, один раз git push

Это классическая грустная история одного факапа. Вы безусловно её оцените, если когда-нибудь работали с гитом, мержили ветки и имеете представление о слиянии fast-forward.

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

О, если бы это был какой-нибудь классический git flow! Увы, но это был не он.
Проект жил в двух окружениях: продакшен и демо. Прод проекта собирался из мастер-ветки, а демо проекта — из ветки demo-branch. На демо-стенд выкладывали все задачи для их тестирования перед загрузкой на прод, а ещё скидывали всё, что попадается под руку: черновики, тестовые обновления, эксперименты с настройками проекта... В общем, демо представляло из себя версию прода в горячечном бреду. Поэтому существовало очень гласное правило: никаких подливаний demo-branch в другие ветки, особенно в мастер, чтобы какая-нибудь незарелизенная приколюха не просочилась в продакшен-среду.

Правило это соблюдалось неукоснительно. До того памятного утра.

Одному инженеру понадобилось что-то починить в настройках проекта на демо-стенде. Он отколол себе ветку hotfix от demo-branch («чинить-то надо демо, значит от него и откалываемся» — объяснял он мне потом), что-то там настроил, влил ветку обратно в demo-branch, проверил — на демо всё работает. Ура!

Дело за малым — нужно обновить те же самые настройки на проде. Нет, инженер не слил demo-branch с мастером, всё нормально. Он сделал то, что должен был: взял свою рабочую ветку hotfix, создал пул-реквест в мастер и отправил его мне на проверку.

Я, не подозревая ничего худого, переключился на мастер и выполнил две команды, которые стали роковыми:

git merge new-branch
git push


В этом слиянии слились не только ветки, но и два критических обстоятельства:

1. Ветка hotfix была отколота не от мастера, а от demo-branch.
2. Накануне в мастер-ветку и в demo-branch был подлит один и тот же коммит.

В итоге ветка hotfix успешно влилась в мастер, подтянув за собой в качестве приданного всю историю коммитов из demo-branch, так как была её дочкой.
А из-за того, что последние коммиты в мастере и demo-branch совпадали, гит решил, что он возвращает ветку родителю, поэтому выполнил простое fast-forward слияние, при котором указатель мастера просто переместился на последний коммит из hotfix, заодно встроив в историю ветки все коммиты из demo-branch.

Когда я всё осознал, было уже слишком поздно. «Да что ты, просто отмени мерж,» — скажете мне вы. Я так и хотел сделать. Но fast-forward слияние нельзя отменить. Точнее, в таком слиянии просто нечего отменять. При Fast-forward не создаётся merge-коммит, который является артефактом слияния, поэтому откатить этот процесс невозможно. Можно только отменить отдельные коммиты, которые подтянулись из сливаемой ветки.

В нашем случае таких коммитов оказалось несколько десятков, и они равномерно распределились по всей истории: demo-branch срослась с мастером как несчастные полярники под влиянием пришельца-мимикриста из фильма «Нечто».

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

Мир был спасён, опасность миновала. Но ситуация от этого не переставала быть страшной. Совершенно необходимо было принять какие-то меры, чтобы это больше не повторилось.

И меры были приняты:

git config merge.ff false


Этой командой я запретил fast-forward слияния в своём репозитории с тем, чтобы всегда, ВСЕГДА создавался коммит слияния. Теперь в случае очередного факапа я смогу хотя бы отменить мерж и избежать ужасных нечто-монстров.

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

#практика
🔥31
Привет! 26 февраля в Москве состоится вторая конференция WriteConf, которая объединяет всех пишущих специалистов в айти: редакторов, технических и ux-писателей, контент-мейкеров, SMM и маркетологов. Будет чисто наша писательская тусовка и много полезной информации по коммуникациям, текстам, инструментам и практикам работы. Много реального опыта и практических кейсов. Крутые спикеры прилагаются)

Билеты можно приобрести по ссылке, а подробности узнать в официальных каналах в телеге и вк.

Приходите, будет интересно!

P.S. Я тоже буду выступать: на личном примере расскажу о том, как организовать большую систему документирования с небольшими затратами. Надеюсь, увидимся)

#карьера
23🔥7
Parawriter
Привет! Я посмотрел на свои часы и понял — время пришло 🕰 Пришло время объявить новогодний розыгрыш от парарайтера! В этом году Дед Мороз принесёт в подарок бесплатное участие в первом потоке большого мастер-класса «Docs as Code для ребят постарше»! Здорово…
Media is too big
VIEW IN TELEGRAM
Привет-привет!

Одни уже разворачивают свои рождественские подарки под Фрэнка Синатру и Бобби Хелмса, другие сидят в офисе и закрывают рабочие задачи, ну а мы с нетерпением ждём результатов новогоднего розыгрыша по docs as code!

В конкурсе приняли участие 94 подписчика. Спасибо всем вам за внимание и интерес к нашему docs-as-code мастер-классу!

Беспристрастный рандом-скрипт выбрал победителя. И им становится @stessy91 🎆 Поздравляю, бесплатное место в первом потоке курса ваше)

Всем счастливого Нового Года! Ещё увидимся)

#карьера
Please open Telegram to view this post
VIEW IN TELEGRAM
👏18🎄11👍5🕊1