#инглишлангуаге

Всем привет!
Hi everyone!

Давайте поговорим сегодня об англоязычной документации🇬🇧 В текущих реалиях может показаться, что это не самый востребованный вид доки, однако английский по-прежнему остается языком международного общения. Так что, даже если ваш продукт не используется в странах, где фраза "English is our national language" встречается НЕ только в учебниках, инструкции для иноязычных пользователей в большинстве случаев стоит писать именно на английском. Если же речь идет о мультиязычной документации, также есть смысл выбрать английский исходным языком. Дело в том, что это поможет сэкономить время и средства на переводе документации. Ведь зачастую проще (и, как правило, дешевле) найти переводчика с рабочей парой, например, арабский-английский, чем арабский-русский.

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

1️⃣ Первый и основной: больше английского богу английского! Внедрите английский в вашу ежедневную рутину. Потребовалось что-нибудь загуглить? Захотелось прочитать что-то в википедии? Вы знаете, какой язык выбрать для этих действий) Или можно сначала сделать всё это на родном языке, а потом уже посмотреть what is the English word for...

2️⃣ Читайте инструкции на английском. Любые! У многих наверняка есть целая "библиотека" мануалов для бытовой техники. Найдите в оглавлении брошюры к любимому холодильнику (микроволновке/стиралке) заветные буковки EN и посмотрите на привычные действия под новым углом! Но будьте осторожны: порой инструкции на английском к технике от наших китайских друзей оставляют желать лучшего...

3️⃣ Изучайте качественную англоязычную документацию. Можно начать с крупных мировых корпораций, например, Microsoft, Apple, Google. У многих таких компаний есть открытые стайлгайды, обязательно изучите их тоже.

4️⃣ И, наконец... просто пишите на английском. Да, в стол. Но если воспринимать это именно как тренировку, то дело должно пойти веселее. Начните с написания каких-нибудь коротких инструкций. Лучше постараться не переводить, а именно писать на английском, т.е. сразу строить в голове фразу на нем, не опираясь на привычные для нас структуры русского языка.

Поделитесь в комментариях, на каких языках вы пишете (или мечтате писать) документацию✍️

А впереди вас еще ждет подборка того, что полезно почитать, если пишешь на английском 😉

#мемница
Когда просишь разработчика помочь с документацией

#инглишлангуаге

Всем привет!

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

Так что мы возвращаемся со списком того, что еще полезно почитать тем, кто пишет или хочет писать на английском:

📑 Статьи на хабре от documentat.io о том, как улучшить английский в документации: раз и два (кстати, там в конце тоже есть подборки полезных ресурсов)
📑 Еще одна статья на хабре, но уже о том, как устроен процесс локализации и документирования в Лаборатории Касперского
📖 William Zinsser 'On Writing Well. The Classic Guide to Writing Nonfiction' - практически "Слово живое и мертвое", но на английском и об английском
📖 The Chicago Manual of Style - примерно то же самое, что справочник Мильчина для русскоязычных писателей
📖 В.Л. Каушанская 'A Grammar of the English Language' - пожалуй, достойна сравнения со справочником Д.Э. Розенталя
📖 Sheryl Lindsell-Roberts 'Technical Writing For Dummies - да-да, такое и про техписательство есть!
📖 Gerald J. Alred, Charles T. Brusaw, Walter E. Oliu 'Handbook of Technical Writing, Tenth Edition' - удобный справочник по основам технического писательства
📖 Jonathan Price, Henry Korman 'How to Communicate Technical Information: A Handbook of Software and Hardware Documentation' - еще немножко (или множко) о том, как писать документацию
📖 Niaw de Leon 'Microcopy: Discover How Tiny Bits of Text Make Tasty Apps and Websites' - про интерфейсные тексты
📖 Final Eye: блог о редактуре ИТ/медпереводов, техписательстве и обучении переводчиков - тут, кажется, и так всё понятно)

Напишите в комментариях, что еще могли бы порекомендовать сами ✍️

#мемница

С днём технического писателя, друзья!

#личныйОпыт
Всем привет!
В Большом чате техписов запустили флешмоб: любой участник может рассказать о том, как стал техписателем.
Мы с Машей поддержали флешмоб здесь и здесь. А Катина история выходила в этом канале.

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

Читайте и вдохновляйтесь❤️

#писалитирекомендует #какэтоработает

Всем привет!
Делимся информацией о бесплатном митапе для техписателей и их тимлидов.

6 марта Лаборатория Касперского (оттуда родом наша Катя😊) проведет Kaspersky Tech Fest.

Какие темы раскроют:

1️⃣ Поиск техписателей.
2️⃣ Онбординг и адаптация.
3️⃣ Развитие и карьерный трек.

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

Кому интересно — в Лабораторию Касперского часто берут стажёров. Страница с вакансиями легко гуглится по запросу "стажировка касперский".

Кстати, и про стажёров тоже расскажут. И на вопросы обещают ответить.

Регистрироваться вот здесь. Мы уже)

Всем привет!

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

Часть 3. Неожиданная обратная связь

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

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

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

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

Когда через неделю из отпуска вернулся руководитель отдела, он подключился к общей работе. Пенелопа воодушевилась: руководитель похвалил их самостоятельность, план и сплочёную работу. Она решила, что это лучшее место работы, которое может быть, пока ей не пришло приглашение на встречу «1–1».

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

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

#невыдуманныеистории #Пенелопа_ищет_икигай

#мемница

«Главное в расследовании — не выйти на самого себя»

#писалитирекомендует
Всем привет!
Недавно познакомились с ребятами, которые пишут в блог IT-компании Reactive "Проспал планëрку". У них вышел интересный материал про техписателей.
Делимся😊

#флешмобити

Друзья, предыдущий пост оказался довольно резонансным) И навёл нас на мысль: а не устроить ли нам флешмоб?

Расскажите в комментариях, как обычно проходит ваш рабочий день✍️ Ведь на вкус и цвет фломастеры техписатели такие разные!

#писалитирекомендует

Всем привет!
Совсем скоро пройдёт Первая Международная конференция технических писателей TechWriter Days — 5-6 апреля 2024 в Москве. Мероприятие состоится в гибридном формате - офлайн + онлайн-трансляция.

2 дня, 3 параллельные секции, 50+ докладов и мастер-классов — участники обсудят актуальные темы, тенденции и лучшие практики в области создания технической документации и коммуни️кации в технических сферах.

Доклады ориентированы на разный уровень подготовленности участников.

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

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

💥 Бонус для подписчиков — скидка 15% на билеты по промокоду PISALITY.

Для удобства ссылки даём отдельно:
• билеты
• программа
• контакты организаторов.

P.S. На этой конференции Семён Факторович представит результаты большого исследования, которое его команда проводила с начала года.
Обращайте внимание на уровень аудитории доклада.
P.P.S. Школа Техписалити! в лице одного из админов участвовала в программном комитете конференции.

#практика

UPD: задание улетело, как горячий пирожок😉
Ну, не унывайте, ещё найдется)

Прошу минутку внимания!)

Начинающие техписы, которые бы хотели сконтрибьютить в опенсорс, отзовитесь)
Есть автор одной утилиты, который бы не отказался от помощи в написании небольшой инструкции) но сроки чуть поджимают)
Писать мне (Лиде) в личку @litulyagan