Господа технические писатели, у нас открылась вакансия 🤟


Что делать

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


На что смотрим

- опыт разработки хотя бы простых скриптов на баше или sql-запросов;
- навык проведения интервью и уточнения деталей.

Остальному научим по ходу дела 😇

Статья на понедельник

Как использовать ChatGPT в продуктовом менеджменте

😀 Что вообще такое это ваше чатжпт
😀 Какие промты лучше использовать
😀 Почему чатжпт нужен продактам

И опять #поехала 🐈

ChatGPT подсказал тему для поста

Лучшие практики технической документации

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

Пройдёмся по основным принципам ❤️

Актуальность

Как бы космически вы ни писали тексты и в насколько удобные местах бы её не размещали — если Справка неактуальна, то её уже не спасти.

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

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

Простой язык

У нас было 99 откликов на вакансию, мы сказали, что не пишем по ГОСТам, у нас стало 199 откликов.

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

Структура

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

За это, кстати, документацию часто и называют сухой.

Регулярное обновление

Мало доку написать, доку надо обновлять (с)

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

Единственный сценарий, в котором дока не будет устаревать — встроить её в процесс разработки продукта.



И Notion AI рекомендовал добавить заключение
Следуя рекомендациям, описанным выше, вы можете создать документацию, которая будет полезна и понятна для пользователей 👍

Если вам нужно было странное, но забавное шоу на вечер воскресенья: Конфетка от ТНТ

Кравец и Мартиросян стебут Бузову под Иванушек Интернешнл, перепевающих кринжовый клип десятиклассника из нулевых 😂

Статья на понедельник ✨

Why you should learn useless things

(там по пунктам и кратко, поэтому без завлекающего текста от меня)

Сегодня ровно месяц, как я начала носить брекеты.

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

Это набор для сумки, в ванной то же самое плюс литр жидкости для ирригатора, запас ёршиков и ирригатор побольше 😎

Инсайт прошлой недели:

издательствам всё равно, читают ли вас, главное, чтобы вас покупали 🥸

Поэтому личный бренд, личный опыт, личные интересы и всё вот это от личности автора выходит вперёд гениального текста ‼️

И подтверждение этой мысли на Medium

Мне так нравится, что в магазине Силы Ветра можно просто купить яхточку 🐈

/что-то на анимешно-психологическом с нотками рефлексии/


Договаривались с сестрой, что на следующий аниме-фест пойдём в косплее, поэтому в корзине на Ozon уже несколько месяцев лежат парики Макимы и Павер.

При этом я искренне считаю, что Макима — моя младшая сестра. Хотя она уже присылала тест "Кто ты из Человека-бензопилы" и мне упорно выпадает не-Павер.

Это, конечно же, про реальное и идеальное Я

Но вот в чём загвоздка

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

услышала на разборе, что можно было и больше своих эмоций отдать клиенту (💔)

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

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



Результат вашего теста: Макима.

Статья на vc о переиспользовании контента на разных площадках 😎

Безотходное производство контента

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

очень базовые
Полезности для работающих с текстами


😀 Читать

Книги от Главреда:
«Пиши, сокращай» и «Новые правила деловой переписки» — в первую очередь, остальные книги по желанию

Слово живое и мёртвое (Нора Галь)
Много примеров о тонкостях подбора слов

Думай о смысле. Будни переводчика IT-текстов
Больше о переводах, но базовые принципы хорошего текста хорошо раскрыты

Рассылка «Редстандарты»
Базовые правила оформления текста

Подготовка технической документации на habr
Статьи от практикующих техписателей


😀 Смотреть

Записи лекций Академии Гипербатона
Курс от documentat.io

Внезапная поездка в марте наконец-то оформилась в видео ✨

📺 Куда мы поехали на этот раз?

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