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

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

Мой курс по редактуре текстов в IT → https://tinyurl.com/28smysfs
Download Telegram
#Объясняю_ITмемы

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

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

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

Ну и скобочки эти похожи на птичек, поэтому собственно это косяк и он летит. Лучше бы не летел)
😁24🔥9👍3
❔В чем заключается работа редактора❔

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

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

Все прочие средства: структурирование, исправление стилистических ошибок, добавление примеров и иллюстраций и т.д. и т.п. — это все инструменты присвоения тексту понятности. По крайней мере для меня так. Это кстати в моей голове роднит редакторов с преподавателями.

А что вы думаете об этом вопросе? В чем для вас суть работы редактора?
Please open Telegram to view this post
VIEW IN TELEGRAM
👍20🔥6🤔5
#Объясняю_ITмемы

Бэкенд — это внутренняя логика сервиса, а фронтенд — его лицо. Они пишутся на разных языках по разным технологиям, поэтому и люди этим обычно занимаются разные.

Как правило в командах есть руководитель, который контролирует весь процесс разработки. Часто это тимлид, то есть team leader, лидер команды.

Может показаться, что тимлид сам не ходит, постоянно что-то контролирует и по сути только мешает программистам работать. Но на самом деле без него получится примерно так, как на этом меме.
👍11🔥7😁7
😏Почему вам в статьях нужны мемы

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

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

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

Я стараюсь использовать мемы везде, где это позволяет тема и тон оф войс издания. Но не те мемы, которые тупо заполняют пространство, а те, которые как-то закрепляют информацию.

Сразу приведу пример. В языке JavaScript есть прикол — когда мы задаем переменную, мы не говорим, строка это или число. И по умолчанию язык может посчитать, что переменные n=1 и m=2 — это строки, а не числа. В итоге если вы сделаете операцию m+n, вы получите не ожидаемую «3», а «12» — потому что JavaScript не сложил числа, а сложил строки, расположив их рядом.

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

А что вы думаете про мемы в статьях? И используете сами?
Please open Telegram to view this post
VIEW IN TELEGRAM
😁9👍8
🖥Как я пишу примеры кода для статей🖥

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

Решить проблему с кодом мне помог ChatGPT. Он прекрасно справляется с примерами кода разного уровня: может сравнить одну и ту же операцию в разных языках, продемонстрировать наглядно какую-нибудь библиотеку и даже написать с нуля несложную программу, например, игру.

В прикрепленных картинках — примеры кода, которые он мне выдал по разным запросам. Я использую российский сервис Chad, который дает доступ к ChatGPT без всяких заморочек.

Главное здесь помнить, что ChatGPT пока не идеален, и эксперт все равно должен будет проверить, что он там понаписал. Но проверить проще, чем написать — особенно учитывая, что ChatGPT прекрасно комментирует все, что накодил.
Please open Telegram to view this post
VIEW IN TELEGRAM
Please open Telegram to view this post
VIEW IN TELEGRAM
👍8🔥8
#Объясняю_ITмемы

Есть языки программирования: Python, PHP, Java, C#, C++ и всякие еще другие вроде Go. На них программисты пишут программы, которые умеют что-то делать — например, считать или анализировать данные.

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

Поэтому говорить, что HTML язык программирования — нельзя. Но так иногда говорят, потому что HTML «маскируется» и «тоже IT» — прямо как этот котик, притворяющийся хлебом.
😁14👍9🔥3
🐾Почему аналогии плохи для споров, но хороши для текстов

Аналогия — это когда вы поясняете что-то сложное или неоднозначное через что-то более простое и понятное, но из другой области. Сравнивая языки программирования и HTML с хлебом и котиком например (это как в посте выше). В отличие от примера, тут мы не показываем применение сложного на практике, а берем объяснение из другой области, просто чтобы что-то сложное стало понятнее.

🐾Аналогии иногда любят использовать в спорах, приводя их как аргумент. Но это прям так себе идея, потому что внешнее сходство не означает сходства внутреннего. Слышали когда-нибудь фразу: «Хорош тот ключ, что открывает много замков — и плох тот замок, что открывается многими ключами»? Ее иногда используют для оправдания женской моногамии и мужской полигамии, если что =) Это как раз аналогия, вот только люди не ключи и не замки, и никаким вообще логическим доказательством чего-либо это не является. Поэтому использовать аналогию, чтобы доказать правдивость чего-то через якобы «подобное» — это ошибка.

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

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

🐾А вы часто используете аналогии в своих статьях? И что думаете об аргументацию через аналогии? Поделитесь в комментариях!
Please open Telegram to view this post
VIEW IN TELEGRAM
👍11🔥5🤔2
🎭«Пассивная агрессия» в статьях🎭

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

Суть в том, что в статье постоянно встречаются фразы вроде:
— «Ответ на этот вопрос очевиден, но давайте все-таки его рассмотрим»
— «Для понимания этого вам бы надо подтянуть свои знания в такой-то области».
— «Подробно мы на этом останавливаться не будем, про это уже написаны кучи статей, прочитайте их» (ссылок на статьи нет).
— «Если вы это подзабыли — это, конечно, плохо, но сейчас мы вам напомним».
— «Об этом мы писали выше, не будем тут повторяться, вы же читали внимательно и запомнили».

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

Но важно всегда понимать, что если вы считаете вещь всем известной — про нее просто не нужно говорить. А если считаете ее хоть немного неизвестной — не называйте вопрос очевидным и просто спокойно на него ответьте.

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

А вы бы кстати как назвали такое «поведение» в статьях? И как часто с ним сталкивались? И какие оно у вас ощущения вызывает?
🔥13👍8😱2🤔1
❔Как вы обозначаете свою профессию?❔

Каждый раз, когда меня спрашивают, кем я работаю — я теряюсь.

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

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

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

Остановилась пока коммерческом редакторе, но чувствую, что что-то не то. Так что расскажите, а как себя называете вы, опираясь на специфику вашей деятельности? Особенно вне диджитал и редакторской тусовки?
Please open Telegram to view this post
VIEW IN TELEGRAM
👍13🤔4
🖇Не нужно постоянно делать списки

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

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

«Далее необходимо разделить приложение на две части:
- клиентский код,
- серверный код.»


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

На мой взгляд, если в списке две–три сущности, и они однотипные и простые — их нужно просто оставить в предложении, вот так:

«Далее необходимо разделить приложение на две части: клиентский и серверный код».

Так гораздо легче и чище.

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

Схема может показаться слишком сложной, но на то есть своя причина. В этом поде у нас три контейнера:

1. В первом работает Vector. Его основная цель — сбор логов.
2. Второй контейнер — Reloader. У пользователей нашей платформы есть возможность описывать собственные пайплайны сборки логов. Специальный оператор берёт заданные пользователями данные и составляет configmap для Vector. Задача Reloader — проверить, что config правильный, и, если так, перезагрузить Vector.
3. Третий контейнер — Kube RBAC proxy. Он важен, поскольку Vector выводит различные метрики о собираемых логах. Эта информация может быть конфиденциальной, поэтому важно защитить её надлежащей авторизацией.
👍25🤔3👎1
🗒Заключения к статьям

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

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

Иногда их пишут в таком стиле:

В этой статье вы узнали:
1. Что такое сепульки.
2. Как производить сепуление.
3. Кто такой сепулятор.

Я считаю, что так делать нельзя, это никак не помогает читателю ничего подытожить. Вместо этого лучше делать так:

В этой статье вы узнали:
1. Что сепульки — это специальное устройство, которое умеет....
2. Что с помощью сепулек можно производить сепуление — популярную процедуру, которая нужна, для того, чтобы....
3. Что сепуление можно делать не самому, а делегировать специальному человеку — сепулятору. Вот на этих сайтах его можно отыскать: ... ... ...


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

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

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

Пишите в комментариях, как вы стараетесь писать заключения, и стараетесь ли вообще. И ставьте реакцию молнии, если хотите поговорить про вообще нужность и ненужность заключения — напишу про это что-нибудь)
Please open Telegram to view this post
VIEW IN TELEGRAM
⚡18🔥7👍3
❤️Моя стратегия жизни в мире сбоев и блокировок❤️

Интернет вчера опять сбойнул и ВК был доступен, а Гуглдоки например нет. Что угодно в любой момент может надолго или навсегда отключиться — ничего с этим не поделаешь. Чтобы не пострадать от этого, я делаю следующее:

1. Раз в неделю делаю бэкап Гуглдиска — вручную качаю самые важные документы себе на компьютер. Наверное есть инструменты автоматизации, но мне проще вручную. Иногда если написала что-то очень важное — бэкаплю сразу.
2. Слежу за новостями о возможных блокировках. Если где-то что-то говорят — предпочитаю или вообще сразу перейти на альтернативу, или хотя бы поискать. Так я ушла из Трелло для ведения личных дел еще до того, как с ним возникли проблемы.
3. Не игнорирую нейросети, хотя многие доступны как-то мутно — пользуюсь российскими или способами обхода и доступа к зарубежным. Нейросети пока не супер-важны, но скоро станут базовым навыком, как компьютерная грамотность — не хочу его упустить из-за блокировок. (Ставьте реакцию глаз, если хотите, чтобы мы поговорили про то, как пользоваться нейросетями в редакторской работе в России без страшных танцев с бубном).
4. Не удаляю текстовые и табличные редакторы с компьютера, хотя почти ими не пользуюсь. Во время сбоя вот пригодились, чтобы срочно распечатать документ.
5. Все критически важное держу у себя на диске и в российских облаках типа Яндекса, но без фанатизма — есть риск потерять, но наверное как-то это переживу.

В итоге по мне все эти принципы помогают не нервничать, ничего не терять и нормально работать, даже когда что-то куда-то сыплется. Поделитесь в комментариях, что делаете вы.
Please open Telegram to view this post
VIEW IN TELEGRAM
👀25👍2
#Объясняю_ITмемы

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

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

Это как если бы вам как редактору в качестве тестового всегда давали похожий текст и задание «Придумайте к тексту 5 заголовков».

Так что котик грустит в бесконечном цикле одинаковости.
😁5👍1
⌨️Нейросети в России без бубна⌨️

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

Делаю я это в двух сервисах. Оба не рекламирую, мне не платили — просто делюсь опытом.

✍Алиса.Про от Яндекса. Это YandexGPT 4, там есть работа с текстом и Шедеврум для картинок. Супер-дешево (я плачу 100р в месяц), без лимитов на генерации — видимо пока учится и растит популярность. Качество среднее, выдаёт много бреда, картинки генерит не очень точно, но для многих задачек реально хватает.

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

🖋ChadGPT. Агрегатор, предоставляет доступ к целой группе нейросетей, в том числе ChatGPT4o и Миджорни. Оплата русской картой, тарифы гуманные — от 300 до 1700 в месяц. Но не безлимит — генерации в разных сетях стоят по-разному внутренних токенов-слов, и может понадобиться доплачивать. Все неиспользованные в месяце сгорают, то есть если купить тариф за 1700 и месяц не пользовать — всё пропадёт. Тут ссылка реферальная, дает бонус в 10000 слов при регистрации — и вам, и мне приятно.

Сюда я прихожу за более сложными объемными задачами, если понимаю, что и правда надо. Генерация картинок меня не очень устраивает скоростью и слишком большим обилием моделей, в которых я не разобралась, а вот работа с текстом на порядок лучше Алисы. Особенно радует возможность как в оригинальном ЧатГПТ прикреплять файлы для анализа.

Вот и всё) Расскажите, пользуете ли вы нейросети, и если да, то какие и как именно.
Please open Telegram to view this post
VIEW IN TELEGRAM
👍7🔥3
Большой гайд про заключения в статьях

Начала писать пост про заключения: когда нужны, когда не нужны, как писать. Поняла, что в пост не влезает и нужно сделать много примеров, поэтому запилила статью на VC. Переходите, читайте, получилось довольно подробно → https://vc.ru/u/152954-lena-shpringer/1760640-gaid-po-zaklyucheniyam-k-statyam-zachem-kogda-i-kak-pisat-s-primerami-iz-realnyh-statei
🔥5👍3⚡1
#Объясняю_ITмемы

Иногда в собеседованиях айтишников (особенно часто так было раньше) задают один классический вопрос: «Что происходит, когда пользователь вводит URL в браузере?». Подразумевается, что человек кратко опишет процесс обмена информацией между браузером и «интернетом», то есть покажет свою компетентность в базовой работе интернета. Это важно знать программистам, чтобы правильно писать код для интернет-приложений.

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

В общем, на абстрактный вопрос был получен абстрактный ответ — не надо так.

А вы кстати знаете, что происходит, когда пользователь вводит url в браузере? Напишите в комментарии =)
😁6🤔1
Опрос про работу на скорость

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

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

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

Есть и другие редакторы — если откажетесь вы, текст возьмет другой.

Как вы поступите? Ставьте реакции:
👍Просто возьмусь и сделаю как получится
🤔Возьмусь, но попробую все-таки связываться с автором, как-то его качать, возможно попросить быстро ответить других экспертов или коллег.
👎Точно откажусь и не буду таким заниматься.

Напишите в комментарии, почему выбрали тот или иной вариант. А я потом напишу пост, как обычно поступаю я, потому что у меня такие ситуации не редкость)
🤔15👍8👎1
💻Как я работаю на скорость💻

В прошлом посте был опрос — а теперь расскажу, как делаю я.

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

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

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

Иногда в такой ситуации мы дорабатывает текст уже после выпуска — обычно это касается всяких закрытых материалов или материалов в блоги, то есть тех, для которых важны будущие читатели, а не те, что увидели текст сразу. Это тоже работает и помогает.
Please open Telegram to view this post
VIEW IN TELEGRAM
🔥5⚡1
✂Быстрый пример редактуры до/после✂

Пишите в комментарии, есть ли у вас идеи, как сделать этот кусочек ещё лучше.
Please open Telegram to view this post
VIEW IN TELEGRAM
Please open Telegram to view this post
VIEW IN TELEGRAM
🔥6👍3👀1