Лена из машины
249 subscribers
51 photos
19 links
Советы, лайфхаки и прочие штуки про редактуру IT-текстов.

Делится @LShpringer — IT-редактор и автор в VK Cloud, Яндекс.Практикуме и других. Консультирую в ЛС про тексты в IT.

Мой курс по редактуре текстов в IT → https://tinyurl.com/28smysfs
Download Telegram
👯‍♀️Почему технический автор и IT-автор — не одно и то же

Я
заметила, что эти две сущности часто путают. А они вообще про разное, щас поясню, в чем отличие.

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

Техписы не имеют отношения к маркетингу. Их задача — создать понятную инструкцию для пользователей. В случае со сложными IT-продуктами инструкция часто пишется для других айтишников.

Технический писатель должен отражать конкретную последовательность действий и понимать четкий принцип работы того, о чем он пишет. При этом художественности, пояснений, сравнений и продаж от его текстов не ждут. Он больше «технический», чем «писатель».

👨‍🎤IT-автор, автор в IT
Это человек, который пишет материалы для IT-компаний: статьи в блог, тексты для лендингов, посты в соцсети, письма в рассылки, публикации в СМИ. Его задача — что-то рассказать клиентам и потенциальным клиентам. Поделиться новой технологией, представить продукт, обучить пользоваться новой фишкой, рассказать о решении какой-то технической задачи.

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

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

Я на этом канале рассказываю как раз о работе IT-авторов и IT-редакторов. Технические писатели — отдельная тема, и я, если честно, про нее почти ничего не знаю)
🔥16👍6🤔1
🧑🏻‍🏫Когда кому-то что-то объясняешь — учишься сам

Для тех, кто не знает — я тут недавно запустила курс для IT-авторов и редакторов про тексты в IT. Вот ссылка, если интересно. Но пост не о том) Сейчас, пока работаю над курсом, словила прикольный инсайт.

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

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

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

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

Кстати, за этот инсайт могу поблагодарить свою коллегу и подругу Юлю Сон. Это она меня подбила на запуск курса и потом все организовала и спродюссировала. У нее есть свой телеграм-канал — советую заглянуть, если интересуетесь более организаторской стороной контент-маркетинга: менеджментом, управлением, продажами и всем таким.
🔥20👍2
#IT_словарь DevOps

Аналогия: Представьте, что вы собираете машину. Вы делаете это сразу целиком и отправляете заказчику. Тот что-то смотрит, тестирует, проверяет — и шлет вам ее целиком назад с правками. Вы снова все правите, исправляете — и шлете. И получаете назад. Это — не DevOps.

При DevOps вы шлете заказчику части работы, получаете актуальные правки в реальном времени, и в итоге получаете готовую и устраивающую его машину гораздо быстрее.
🔥9👍3
🐣С какой стороны заходить в IT-редактуру

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

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

👨‍🎓Тексты для курсов. Сейчас вокруг очень много разных курсов, на которых обучают IT-профессиям: Практикум, Скиллбокс и прочее. Часто такие онлайн-школы ведут блоги и набирают туда авторов. Обычно там нужно писать тексты из разряда «Что такое JavaScript», и пока вы их пишете — как раз разберетесь в теме.
🤵‍♂️Тексты для бизнеса. IT-бизнесов сейчас очень много, и все они стремятся продавать свои продукты — ПО или какие-то услуги. Для продажи им нужны тексты — вроде бы про IT, но для тех, кто ничего в этом не понимает. Это часто те же рекламные тексты для лендингов и сайтов, либо какие-то простые статьи в блоги о том, как же выбрать VPN. Этот вариант чуть похуже, чем тексты для курсов, потому что плохо помогает погрузиться в тему. Вы так и остаетесь на уровне «не понимаю глубоко», и углубляться придется самостоятельно. Но зато хотя бы привыкнете к терминам и научитесь брать интервью у айтишников — что тоже очень полезно.

И кстати, обе эти сферы вполне могут стать не стартовой точкой, а постоянной работой. Потому что лезть глубоко в IT — история специфичная и на рынке не самая популярная. А тексты для курсов и бизнеса будут нужны всегда.
🔥16👍3
🌱Как зайти в IT-редактуру без опыта

Часто в вакансиях на IT-автора и редактора просят показать примеры текстов про IT. Это логично, и я сама так делала, когда искала автора. Тогда на проекте у нас особо не было времени на обучение, поэтому требовались люди, которые хоть примерно погружены в контекст.

Но что делать, если в эту сферу хочется, а текстов пока нет? На самом деле вариант только один — взять и написать текст просто для портфолио. То есть самостоятельно выбрать тему и написать, без заказчика со стороны.

🍂Недостаток подобного метода в том, что без эксперта вы, конечно, не напишете ничего супер-крутого. Однако в качестве примера работы в портфолио вполне подойдет текст среднего уровня, просто переработка информации из интернета, с вашей структурой, аналогиями и пояснениями.

Текст даже не обязательно где-то публиковать — можно оставить его в гугл-доке и просто добавить в портфолио ссылку.

Правда учтите, что это все равно не должен быть «просто текст». Подумайте, кто бы у вас мог его заказать, кому он был бы интересен — и отталкивайтесь от этого при написании. То есть вообразите себе ЦА и работайте с ней, как если бы реально писали статью за деньги.

🍀Часто примеров просят несколько. Но если честно, лучше показать несколько своих крепких работ на другую тему и один хороший текст реально по теме IT, чем три каких-то невнятных пресс-релиза, в которых просто упоминается программирование или облако.

Если хотите, чтобы я собрала список тем, на которые можно написать эти самые «статьи для портфолио» — ставьте посту огонек, соберу что-нибудь одновременно не слишком сложное, но и не совсем примитивное.
🔥51👍1
🍄Темы IT-статей, которые можно написать без эксперта для портфолио

Вдогонку к прошлому посту. Если у вас в портфолио нет статей на IT-тему, можно набросать что-то от себя в таком духе. Главное поглужбе закопайтесь в тему и постарайтесь на все 100% — без экспертов даже мне такие материалы писать непросто. Но лучше иметь статью хотя бы такого уровня, чем не иметь вовсе.

💻Программирование
—
Язык Golang — зачем учить его в 2023 году
— Как перейти с фронтенда на бэкенд: что изучить, чтобы стать бэкендером
— Какие фреймворки обязательно знать разработчику на (Подставьте любой язык программирования)
— Лучшие IDE для разработчиков в 2023 году
— Возможности Visual Studio Code

🔧Системное администрирование
—
Что такое Kubernetes и что о нем важно знать сисадмину
— Как работает Kubernetes в облаке
— Обзор облачных платформ, доступных в России: описание, плюсы и минусы
— Какие решения выбирать в 2023 году: вендорские или опенсорсные
— Что выбрать для проекта: хранилище S3 или базы данных

⛵️Большие данные
—
Что такое MLOps и почему в 2023 без этого никуда
— Зачем бизнесу на самом деле нужны большие данные
— Что такое Big Data и какие инструменты нужны, чтобы внедрить эту технологию в свой бизнес
— Какой стек технологий понадобится, чтобы организовать машинное обучение у себя в компании
— Где хранить большие данные: обзор инструментов

👨‍🎓Обучение IT-профессиям
— Войти в IT: какую профессию выбрать, если пока совсем не айтишник
— Топ языков программирования в 2023 году
— Кем стать: фронтендером или бэкендером
— Кем стать: программистом или сисадмином
— Как сисадмину стать DevOps-инженеров
👍21🔥9🤔1
#IT_словарь
Пример: В вакансии разработчика указано, что надо знать JavaScript, HTML, CSS, ReactJS, NextJS и TypeScript. Это и есть стек технологий, с которым работает эта компания.
👍6
🤖Можно ли как-то поставить ChatGPT себе на пользу в работе

Пока статью он за нас не напишет (а жаль), но я его уже применяла для нескольких прикольных штук:

→ Написать пример кода. Он отлично справляется с простыми примерами применения какой-то функции или фреймворка, причем еще и классно комментирует этот самый код.
→ Собрать подборку ресурсов для чего-нибудь. Он очень прикольно собирает ссылки на ресурсы, например, для изучения программирования, причем особенно на англоязычные.
→ Быстро объяснить какой-то термин простым языком. Он умеет в прикольные аналогии, мне очень понравилось.
→ Набросать самый каркас статьи. Например, если есть план, он может вам накидать какой-то общей фактуры по каждому пункту — а это потом легко будет дополнить примерами и пояснениями.

Ставьте посту огонек, если хотите реальных примеров по каждому пункту — наделаю скриншотами, это забавно. Ну и в следующих постах расскажу, для чего эту нейронку применять точно не стоит и почему с ней пока надо быть аккуратнее.
🔥41👍2
Как и обещала — примеры использования ChatGPT. Вот они, слева направо:
1) Генерация кода. Я не знаю, верный он или нет, была бы статья — чекнул бы эксперт. Но в прошлый раз мне нагенерил верных.
2) Подборка. Заметьте, есть даже русскоязычные.
3) Пояснение простым языком. Оч круто заменяет простой гуглеж.
4) Каркас статьи .Тут уже больше воды, но как базис можно использовать.
🔥6👍2😱1👻1
💣С чем ChatGPT НЕ поможет редактору в работе

❌Не отредактирует за вас текст. Даже простенькая редактура с подробнейшими описаниями, что и как сделать, ему не под силу. Результат получается неудовлетворительный, с тяжеловесными конструкциями, а местами с искажением смысла. Быстрее самому отредачить, чем править еще и за нейросетью.
❌Не проверит факты. Если нейросеть чего-то не знает — она не признается, а просто начинает нести чушь. Наоборот, это вам придется проверять все озвученные им факты, чтобы не сесть в лужу.
❌Не расскажет свежую информацию. Он обучался на данных до 2021 года.
❌Не поможет с форматированием. Списки — максимум его выдачи. Надеюсь, потом это поправят.

❔Где потестить ChatGPT
Я вот вам все рассказываю, а вы поди думаете, что в России он вообще не доступен. Это не так. В телеграме есть боты, например, этот бесплатный и отлично работает @tg_gpt3_bot, пусть и с некоторыми ограничениями. Плюс есть и платные сервисы, они легко гуглятся по запросу «ChatGPT в России».
🔥9👍1
❔Про что вам еще рассказать❔
Ладно, хватит уже нейросетей, они кажется всех достали, и меня тоже =)

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

Разберем сразу на примере, чтобы было понятнее. Представим, что вам нужно написать статью по теме «Как упростить функциональное API-тестирование в облаке». Вы наверняка вообще ничего в этом не понимаете. Но надо созвониться с экспертом и как-то с ним об этом поговорить.

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

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

А потом просто берите вот эти вопросы, возможно чуть адаптируя их под свою ситуацию:
1) Зачем вообще стоит задача это делать?
2) Чем конкретно этот способ/инструмент/подход отличается от других существующих?
3) Какой стек нужен для реализации того, что задано в теме интервью? Почему именно этот стек?
4) Что конкретно по шагам нужно делать, чтобы реализовать то, что указано в теме статьи? Есть ли для этого примеры кода/консольных команд/скриншотов/видео?
5) Какие у этого метода/инструмента/подхода есть недостатки и слабые места? Как их можно нивелировать?
6) Представьте, что мы уже выпустили статью. О чем на ваш взгляд могут спросить в комментариях? Как бы нам на эти вопросы еще в статье ответить?

В большинстве своем этих вопросов хватает, чтобы направить беседу в правильно русло и задавать потом минимум уточняющих вопросов. Важно помнить, что вам не обязательно понимать все, что эксперт говорит — понимать его должны такие же эксперты. А про редактуру непонятного мы еще поговорим.
🔥23👍4
👍Когда пишете на Хабр — не доводите до идеала

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

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

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

Я когда редактирую тексты экспертов на Хабр, всегда стараюсь:
— Минимально вмешиваться в терминологию. Он наверняка знает, как принято говорить в их среде. Использует англицизмы через слово — да пожалуйста, значит, так нужно.
— Сохранять непринужденность текста. Больше разговорных слов, инверсия местами — тут не портят, а скорее помогают придать тексту живости.

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

Напишите в комменты, что думаете про такую «редактуру спустя рукава», а то вдруг я все-таки обленилась и гнать меня надо отсюда взашей)
Please open Telegram to view this post
VIEW IN TELEGRAM
🔥14👍4🤔3
🦆Я тут недавно провела консультацию по IT-редактуре, и мне понравилось

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

В общем, раз мне понравилось, приходите и вы если что за консультацией. Я могу:
📝Посмотреть ваш текст и сказать, что в нем стоит исправить. Подсказать, как дальше писать еще лучше.
⚒В общем пообщаться про IT-редактуру: где искать авторов, как общаться с экспертами, куда публиковать тексты.
🔨Обсудить какой-то узкий запрос. Например, на какие темы писать для вашей ниши. Или как составить вопросы к созвону для конкретного текста.
👩🏻‍🎓Дать обратную связь по домашке, если вы проходите мой курс про тексты в IT.

Общаться можем как текстом, так и голосом, есть разные варианты, а я всегда открыта к предложениям. Пишите мне в ЛС → https://t.me/NigrumKross. По деньгам это будет в диапазоне 500–3000 ₽, в зависимости от запроса.

В картинке прикладываю отзыв на консультацию, чтоб вы поняли, как все прошло.
Please open Telegram to view this post
VIEW IN TELEGRAM
🔥8
🏎Писать на Хабр стало модно

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

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

Но в итоге получилось так, что довольно многие компании, в основном крупные, стали писать про свои продукты на Хабр. И другие подумали — а почему бы нам тоже не попробовать? Это быстро, это просто, это бесплатно. И Хабр стал еще одной модной площадкой, из разряда «Нам нужно вести блог в Дзене, на Виси и на Хабре».

🛴Что с этим не так. Аудитория Хабра с тех начальных времен не слишком изменилась. Люди все еще приходят сюда почитать про сложные IT-штуки, а не про абстрактные технологии. Даже аудитория IT-управленцев тут слегка теряется — статьи для нее есть, но популярностью они почти не пользуются.

Когда компании приходят и рассказывают им не про хардкорный продукт, а про свою CRM, получается ерунда. На Хабре читать этого не хотят, и заходить с этим сюда просто потому что «Все ведут блог на Хабре» не надо. Это пустая трата денег и времени.

🚲Что делать:
—
Не идти на Хабр, если не уверен, что твой продукт технически сложен и интересен айтишникам.
— Если все-таки горит пойти на Хабр, писать не о продукте, а о его разработке. То есть как и какими технологиями вы его реализовали, с чем сталкивались, на чем кодили, какие инструменты подключили и т.п. Тогда и статья будет интересна аудитории, и продукт вы сможете упомянуть. Вполне рабочий вариант, хотя от прямых продаж он очень далек.
👍8🔥5🤔1
😱Новая рубрика, и я не шучу. #Объясняю_ITмемы. Прикрепляю IT-мем и объясняю, что в нем смешного. На самом деле полезная практика для понимания терминов и подбора иллюстраций для статей.

Этот мем иллюстрирует особенность языка программирования JavaScript. По умолчанию он считает введенное значение не числом, а строкой. То есть суммирует строки, что-то вроде «два»+«два»=«двадва». Только в виде цифр. В итоге при сложении чисел можно легко получить неверный результат, потому что программа думает, что вы складываете не числа, а строки, то есть просто символы.

Это популярная ошибки в JS у новичков, а у более опытных она по невнимательности может стать причиной ошибки в работе программы. Не скажу, что это особенно смешно, но мем популярный.

Можете присылать IT-мемы в комментарии. Те, которые не поняли, или просто смешные. Разберем вместе)
Please open Telegram to view this post
VIEW IN TELEGRAM
🔥9😁9
👶🏻Подборка статей по IT, чтобы разобраться в основах

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

👨‍💻Программирование
—
Базовое про популярные языки программирования
— Что такое Гитхаб
— Что такое API
— Фронтенд и бэкенд
— Что такое фреймворк
— Главное про деплой

☁️Облака
—
Что такое IaaS, PaaS и SaaS
— Про частные облака
— Про облачные хранилища
— Базы данных в облаке

💻Системное администрирование
—
Что такое DevOps
— Главное о микросервисной и монолитной архитектурах
— Что такое VPN с точки зрения бизнеса и IT-инфраструктуры
— Что такое DNS
— Что такое контейнеры Докер
— Что такое Кубернетес — большой гайд

🌃Данные
—
Основное про SQL
— Что такое Big Data
— Главное про озера и хранилища данных
— Что такое машинное обучение
— Что такое объектные хранилища
— Немного про многомерные БД и OLAP

🤖Аналитика данных
— ИИ и машинное обучение
— Что такое компьютерное зрение
— Что такое Data Science
— Какие бывают технологии анализа больших данных

🔧Прочее
— Что такое протокол HTTP
— Что такое персональные данные и как их защищают
— Основное про интернет вещей и IoT
🔥18👍6👻3👌1
#Объясняю_ITмемы

Здесь показан невозможный способ запрограммировать шахматы =) Чтобы его реализовать, программисту пришлось бы прописать КАЖДЫЙ возможный вариант позиции фигур на шахматной доске — а их уже после первого хода обоих игроков более 400 штук. То в код пришлось бы внести миллиарды вариантов расположения фигур, что физически невозможно.

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

Если заглядывать глубже, то этот мем — метафора на код новичков. Часто не зная о существовании удобных инструментов, они используют только самые простые. Из-за этого код занимает гораздо больше строк и по факту слишком сильно усложняется.
🔥13😁3👻1