Привет!

Девиз «Пиши! Сокращай!» знают уже наверное все в нашей профессии. Казалось бы, стоит ли снова поднимать тему о том, как писать легко и непринуждённо?

Стоит! Ведь коварный канцелярит прекрасно адаптируется и мимикрирует под доброкачественную речь. Поэтому давайте попробуем дать ему ещё один бой.

Глагол — это действие, это активность, это жизнь. Канцелярит — это запруда, которая останавливает течение нашей речи. Поэтому канцелярит всегда старается заменить глагол чем-то ещё: существительным, причастием, деепричастием или инфинитивом.
Вычислить и вылечить такой канцелярит очень просто: возвращай в фразу действие и радуйся жизни.

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

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

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

Как же вычислить этот коварный канцелярский штамп?

Совсем несложно. Этот коварный штамп строится по шаблону совершать/совершить [какое-то] действие: проводить работу, выполнять анализ, участвовать в выступлении. Если такое словосочетание можно без потери смысла заменить простым глаголом действия, то перед вами штамп: проводить работу = работать, выполнять анализ = анализировать, участвовать в выступлении = выступать.

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

Казалось бы, ну такой безобидный штампик, ну пусть он остаётся в нашей речи! А вот и нет! Это он только на вид такой безобидный. Посмотрите, как в первом моём примере простое действие проанализировать разложилось на три (провести работу по анализу). Канцелярит опасен тем, что притягивает к себе другой канцелярит. Фразы становятся тяжелее, неповоротливые конструкции из причастий и отглагольных существительных нанизываются друг на дружку и превращают ваш текст в монструозное нечитаемое нечто.

Поэтому я советую жечь глаголом любые канцелярские штампы, даже самые милые)

#практика

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

Но унификация не победила авторскую идентичность.

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

Дальше — больше. Теперь, когда ко мне на ревью попадает текст, я понимаю, кто именно из моих коллег его написал. Правда, мои коллеги не технические писатели, а разработчики, аналитики и девопсы, менее искушённые инфостилем, поэтому вычислить их гораздо легче)

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

А вам удаётся сохранить свой стиль в документации? Поделитесь своим опытом в комментариях, будет интересно обсудить)

#флуд

И ещё раз о софтах

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

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

Поэтому я стараюсь всегда оставаться:

– дружелюбным
– в меру вежливым
– готовым помочь

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

Не хватает настойчивости.

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

Однако, настойчивое дружелюбие предполагает соблюдение некоторых правил:

1. Никаких конфликтов.
2. Никакой токсичности в общении.
3. При необходимости только мягкая эскалация (в духе: «пожалуйста, помоги обратить внимание Игоря на такую-то задачу, она срочная, а её решение затягивается»).

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

Кстати, настойчивым дружелюбием можно пользоваться и в рутинной повседневности — попробуйте, не пожалеете)

#практика #софты

Вчера сходил на конференцию Doc Config от Сбертеха.

Много говорили о работе с нейросетями. Я всегда сомневался в своих методах взаимодействия с ИИ, но оказалось, что все делают также, как я))

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

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

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

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

#карьера

Такой плакат висел в нашем офисе в компании, где я работал инженером-проектировщиком. Честно говоря, он меня немного раздражал)

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

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

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

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

#флуд

В этот момент я подумал: хорошо, что у меня нет собаки!

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

Ладно с собакой, может, я один неправильно понял посыл и на самом деле всё прекрасно и однозначно.

Вчера мне попалось гораздо более провокационная штука. Фотографии я не сделал, поэтому текстом:

ВНИМАНИЕ, РОЗЫСК! (красными буквами)

Ниже фотография молодого человека (цветная)

Какие эмоции вызывает это объявление? Я сразу подумал, что это поисковая листовка от ЛизаАлерт или типа того, и что бедный чувак потерялся, ушёл из дома, заблудился в лесу или что похуже.

Стал читать дальше: надо же узнать подробности пропавшего.

Под фотографией шёл текст с описанием человека. И, конечно же, никто не потерялся. Точнее, листовка предполагала, что это мы (читатели) никак не можем найти человека с фотографии, а ведь он замечательный риелтор! Контакты этого чудо-риелтора прилагались.

Что сказать? Надо отдать должное автору рекламы: текст объявления я прочёл до конца. Но захотел ли я позвонить креативному риелтору? Нет, конечно) Судя по тому, что листовка валялась на земле, не я один испытал справедливое возмущение.

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

почти #ux

Привет!

Хотели бы вы попробовать внедрить искусственный интеллект в свою рабочую повседневность?

Я, например, хочу)

Поэтому во вторник, 14 октября, в 19:00 я пойду в гости к ребятам из AI IDE BAS, которые разрабатывают ai-расширение для VS Code. Попробуем с его помощью спроектировать и задокументировать какое-нибудь простенькое приложение) Заодно проверим, могут ли технические писатели использовать AI IDE BAS ✍️

Надеюсь, получится интересная и полезная встреча!

Кстати, вы все тоже приглашены) Приходите в ZOOM во вторник, 14 октября, в 19:00. Будем тестировать инструмент вместе!

Вопросы можно будет задавать по ходу стрима в комментариях в зуме.

Как стать культистом? 😵‍💫

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

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

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

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

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

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

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

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

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

#практика

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

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

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

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

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

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

#флуд

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

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

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

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

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

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

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

#инструменты

Когда игрался с ИИ и проиграл

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

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

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

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

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

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

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

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

#флуд #карьера

Всем привет!
Ребят, осталось три места на январский курс по docs as code.
Если вы хотите принять участие, пишите @novillero

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

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

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

#карьера #docsascode

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

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

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

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

P.S. Когда-нибудь, когда-нибудь я научусь планировать своё время так, чтобы всё успевать, но давайте перенесём это на первый квартал 2026 🙃