Техписалити!
Відкрити в Telegram
Первая открытая школа технических писателей Пишут Лида Туляганова, Маша Щеблякова и Катя Марченко
Показати більше1 986
Підписники
-224 години
+27 днів
+930 день
Триває завантаження даних...
Схожі канали
Хмара тегів
Вхідні та вихідні згадування
---
---
---
---
---
---
Залучення підписників
липень '26
липень '26
+16
в 0 каналах
червень '26
+31
в 1 каналах
Get PRO
травень '26
+26
в 0 каналах
Get PRO
квітень '26
+30
в 0 каналах
Get PRO
березень '26
+34
в 0 каналах
Get PRO
лютий '26
+72
в 1 каналах
Get PRO
січень '26
+74
в 0 каналах
Get PRO
грудень '25
+91
в 2 каналах
Get PRO
листопад '25
+52
в 0 каналах
Get PRO
жовтень '25
+81
в 0 каналах
Get PRO
вересень '25
+41
в 0 каналах
Get PRO
серпень '25
+76
в 1 каналах
Get PRO
липень '25
+55
в 0 каналах
Get PRO
червень '25
+56
в 0 каналах
Get PRO
травень '25
+52
в 0 каналах
Get PRO
квітень '25
+81
в 2 каналах
Get PRO
березень '25
+85
в 0 каналах
Get PRO
лютий '25
+100
в 0 каналах
Get PRO
січень '25
+118
в 2 каналах
Get PRO
грудень '24
+176
в 0 каналах
Get PRO
листопад '24
+115
в 2 каналах
Get PRO
жовтень '24
+91
в 0 каналах
Get PRO
вересень '24
+59
в 0 каналах
Get PRO
серпень '24
+75
в 0 каналах
Get PRO
липень '24
+83
в 0 каналах
Get PRO
червень '24
+75
в 1 каналах
Get PRO
травень '24
+47
в 1 каналах
Get PRO
квітень '24
+105
в 1 каналах
Get PRO
березень '24
+57
в 1 каналах
Get PRO
лютий '24
+97
в 0 каналах
Get PRO
січень '24
+141
в 0 каналах
Get PRO
грудень '23
+53
в 0 каналах
Get PRO
листопад '23
+61
в 1 каналах
Get PRO
жовтень '23
+81
в 2 каналах
Get PRO
вересень '23
+454
в 0 каналах
| Дата | Залучення підписників | Згадування | Канали | |
| 13 липня | 0 | |||
| 12 липня | 0 | |||
| 11 липня | 0 | |||
| 10 липня | +1 | |||
| 09 липня | +1 | |||
| 08 липня | 0 | |||
| 07 липня | +2 | |||
| 06 липня | +3 | |||
| 05 липня | 0 | |||
| 04 липня | 0 | |||
| 03 липня | +3 | |||
| 02 липня | +5 | |||
| 01 липня | +1 |
Дописи каналу
+4#анонс
Всем привет! Несём новости – 16 июля в 16-00 RWB (Объединённая компания Wildberries&Rus) проведёт первый онлайн-митап по технической документации.
- Техническая документация — это фундамент, - рассказывает член программного комитета, наша коллега и ментор движения Women In Tech Люсьена Мирославская. - От документации зависит, как быстро команда масштабирует знания, как новички вливаются в проект и сколько времени пользователи тратят на изучение продукта. И в этом смысле технический писатель — это не роскошный максимум, а самый что ни на есть базовый минимум. Без него команда теряет эффективность. Приходите послушать, как мы запускаем процессы документирования в наших командах.
В программе:
⏹️ «Летопись документации разработчиков WB API» | Лидия Рудакова, лид команды документирования Public API.
⏹️ «Единая система оценки задач техписателей: как внедрить новый подход без боли» | Евгения Красильникова, технический писатель в команде разработки документации и методик обучения ПО.
⏹️ «100 к 1: Как организовать подход "документация как услуга" в одиночку» | Антон Гафаров, технический писатель в команде FinTech Infra.
Модератор – Екатерина Касаткина.
Митап бесплатный.
Ссылка на регистрацию
| 2 | #книги #розыгрыш
Друзья, мы подводим итоги розыгрыша книги Екатерины Ушаковой «Если ты — технический писатель»!
Спасибо за невероятный отклик! Ваши вопросы оказались настолько глубокими и нестандартными, что мы с удовольствием их разбирали.
Итак, барабанная дробь 🥁 Екатерина лично выбрала вопрос, который задел её больше всего:
«Техписатель больше не нужен в команде. Кто виноват и что делать?»
Автор этого смелого и острого вопроса — Вера Хаски. Поздравляем! Книга ждёт своего нового владельца.
Но это ещё не всё! Екатерина подготовила видеоответы и на остальные ваши вопросы. Скорее переходите в комментарии к предыдущему посту — вас ждёт много полезного и честного контента. | 822 |
| 3 | #книги #интервью #розыгрыш
Всем привет! Сегодня в гостях у Техписалити! — Екатерина Ушакова, автор канала Буквально Ушакова и автор книги
📗"Если ты — технический писатель"
которая вышла этой весной.
• Катя, ты не просто технический писатель, но и преподаватель университета Иннополис. В своих интервью ты делилась, что книга появилась ещё и как методическое пособие для твоих студентов. Расскажи, пожалуйста, какие дисциплины ты преподаёшь и какая литература используется в обучении.
• Я преподаю дисциплину Technical Communication in IT. Мы учим студентов не столько писать документацию по шаблонам, сколько дизайнить коммуникации на разных этапах работы с продуктом. В основе лекций — цикл разработки ПО: мы смотрим, какие коммуникации и артефакты нужны на переходах между этапами, чтобы продукт разрабатывался лучшим образом. Курс более фундаментальный, он много объясняет про коммуникации между разными участниками разработки. Что касается литературы — на английском её много, мы даём студентам список рекомендаций из примерно 40 книг. А вот на русском языке такой литературы почти нет. Книга — это другая история: она про хорошую техписательскую практику. Я хотела, чтобы у нас было больше грамотных коллег, в том числе в плане процессов. Чтобы техписатели не боялись развиваться в смежных областях. Ну и конечно чтобы новички могли для себя понять, кем они будут, когда вырастут. Книга скорее для людей, которые хотят разобраться в профессии самостоятельно.
• Чего не хватало тебе в начале карьеры? Какую книгу ты хотела бы прочитать, когда сама начинала и стала ли эта книга ею?
• Когда я начинала, был Гипербатон, были какие-то видео, книги тоже были — но всё это далеко от продуктового подхода. На старте мне этого хватало. А вот когда я начала нанимать людей и развивать команду, остро не хватало адекватных материалов. Нечего было дать новичку и сказать: «Прочитай, и ты поймёшь, как у нас всё устроено». Так что да, эта книга — во многом та, которой мне самой не хватало.
• Планируешь ли ты выпустить другие пособия, чтобы создать цельный образовательный курс по нашей профессии?
• Есть мысли сделать книгу для старших техписателей и руководителей, но пока не готова назвать точную дату или даже год. Если будет достаточно материала и потребность — да, книги будут. А что касается образовательного курса — у меня есть отдельный проект «Буквально», это курсы для техписателей. Тестовый поток уже прошёл, скоро будут анонсы публичного запуска.
• Можно ли считать, что все, кто прочитает книгу, практически прослушал университетский курс?
• Отчасти. Материал всё-таки разный: в университете больше академичности, фундамента, а в книге больше про быстрый старт уже в компании. Можно прослушать курс и никогда не работать техписом, но нести культуру коммуникаций в своей работе. А можно прочитать книгу и никогда не задумываться о всём цикле разработки ПО. Это два разных пути в профессию, которые дополняют друг друга.
Почти весь тираж разлетелся сразу, но у наших подписчиков есть возможность получить её бесплатно. Задайте вопрос Кате в комментариях. Катя выберет самый интересный вопрос и его автору отправит книгу.
Участвовать может любой, но по традиции, если вы находитесь за пределами России, мы попросим контакты вашего друга или другого доверенного лица в нашей стране. | 1 738 |
| 4 | #какэтоработает #средаразработки
Всем привет! Сегодня продолжим разговор о git, а точнее о двух способах объединения изменений, и посмотрим, для каких ситуаций подходит каждый из них.
git merge VS git rebase
Что делают эти команды?
Git merge объединяет ветки и создаёт отдельный коммит слияния, сохраняя временну́ю последовательность коммитов. Git rebase делает историю линейной, но меняет при этом хэши (уникальные идентификаторы) коммитов.
Рассмотрим, как работает rebase из feature в main. Представим, что до объединения в ветках есть коммиты:
feature: A — B — C (коммит 1 июня)
main: A — B — D (коммит 2 июня)
Что получается после rebase:
feature: A — B — C
main: A — B — C — D' (D' — новый хэш)
Почему смена хэша — это плохо
Коммиты — это “записи”, по которым можно восстанавливать историю или отменять изменения, передвигаясь по ним назад. Rebase переписывает хэши коммитов, чем может сломать историю у других участников процесса.
Чем плох merge?
Если есть изменения, merge добавляет новый коммит с двумя родителями — коммит слияния. Более того, при слиянии сохраняется ветвление, и поэтому сложно визуально определить, какой коммит в одной ветке был сделан раньше, чем коммит в другой.
Что происходит при merge из feature в main?
main: A (коммит, от которого создана ветка) — B — C (коммит 1 июня)
feature: A — E — D (коммит 2 июня)
Что получается после merge в ветке main:
main: A — B — C — F (коммит
\ E — D / слияния)
Когда какой путь выбрать?
Merge или rebase — это выбор между полной историей и визуально чистой историей. Rebase можно использовать, чтобы обновить ветку перед слиянием с основной, сохраняя линейную историю. Merge лучше использовать, если ветка общая и в ней работают несколько разработчиков.
❗️Главное правило: не переписывайте историю, которую уже кто-то мог забрать.
Вопрос к мидлам и сеньорам: а вы используете rebase или обходитесь merge? | 1 101 |
| 5 |  #мемница | 1 233 |
| 6 |  #мемница | 1 434 |
| 7 |  #мемница | 0 |
| 8 | #какэтоработает #вопросвлоб
Всем привет! Сегодня мы рассмотрим ситуацию, с которой не так давно столкнулись. Разбор этой ситуации ещё полезен тем, что одной из наших коллег подобный кейс задали на собеседовании. Так что этот пост для рубрик и про практические решения, и про собеседования.
Как выкатить документацию на другом языке, если у вас нет ни времени, ни ресурсов
Представим, что у вас появилась производственная необходимость срочно выпустить документацию на другом языке.
Сразу оговоримся, что подобный подход — это способ потушить пожар, а не выстроить систему правильно.
Подготавливаемся
1️⃣ Узнайте, на сколько языков нужно перевести документацию.
2️⃣ Узнайте, в каких странах вы должны выйти, нужны ли вам домены в этой стране.
3️⃣ Изучите требования законодательства относительно данных в этих странах. Например, нужно ли разворачивать сервис документации на мощностях местных ЦОДов.
4️⃣ Запросите требования вашей службы информационной безопасности.
5️⃣ Уточните, все ли сервисы вашего продукта локализованы в нужных странах. От этого зависит, все ли функциональности будут доступны в этой стране. Если не все, готовьтесь скрывать часть документации.
Заручаемся поддержкой
6️⃣ Возьмите у команды продукта переводы текстов интерфейса.
7️⃣ В условиях сжатых сроков и отсутствия ресурсов мы будем использовать искусственный перевод. Расскажите владельцу продукта о ваших планах, аргументируйте каждое решение. Владелец продукта и менеджер продукта должны быть вашими союзниками, используйте свой талант переговорщика.
Работаем с текстами
8️⃣ Приготовьте на основе переводов словари значений русский — иностранный, столько пар, сколько языков. Эти словари вы сможете использовать в качестве контекста для искусственного перевода. (Помним, что у нас нет времени и ресурсов, поэтому ИИ — наш выход).
9️⃣ Если вам требуются нераспространённые языки, сформируйте словари английский — иностранный. Если у вас изначально есть английская документация, ИИ с английского на редкие языки порой переводит лучше, чем с русского.
1️⃣0️⃣ Подготовьте иноязычные исходники в нужной вам разметке. Загрузите в ИИ в качестве контекста наши словари и с помощью промпта запросите перевод. В идеале лучше настроить интеграцию с системами построчного перевода, но мы помним, что у нас нет времени и ресурсов. Вы можете использовать агенты и прописывать им правила — в этом случае перевод может быть лучше.
Строим, собираем, разворачиваем, тестируем
1️⃣1️⃣ Проработайте архитектуру документации и процессы, которые позволят разворачивать документацию в нужных конфигурациях и на нужных адресах. Это может быть непростой работой и занять приличное количество времени. Если у вас есть помощники-девопсы, вам повезло.
1️⃣2️⃣ Если у вас в продукте есть нелокализованные сервисы, подготовьте скрипты, которые позволят скрывать описания конкретных функциональностей в конкретных странах (на конкретных доменах). Если вы не умеете это делать, вам могут это рассказать наши ИИшные друзья. Для них это несложно, и они в этом практически не ошибаются.
1️⃣3️⃣ Если вы поставляете публичную документацию, позаботьтесь о том, чтобы поисковые системы правильно проиндексировали её. Для этого снабдите страницы нужными метаданными.
1️⃣4️⃣ Протестируйте сборку и развёртывание документации в тестовых окружениях.
Публикуем
1️⃣5️⃣ Получите согласование от владельца и менеджера продукта и опубликуйте документацию. И да поможет вам бог.
Можно ли поддерживать такую документацию в актуальном состоянии? — Да, если реализовать непрерывную локализацию, о которой мы расскажем в других постах. | 0 |
| 9 |  #мемница | 0 |
