Техписалити! – Telegram
Техписалити!
1.91K subscribers
174 photos
16 videos
89 links
Первая открытая школа технических писателей

Пишут Лида Туляганова, Маша Щеблякова и Катя Марченко
Download Telegram
😁30💯6👍1👎1🏆1
Audio
Подкаст с Лидией Тулягановой 03.10.2023

#подкаст #ЛидияТуляганова #встречазнакомство
👍71
#колонкаредактора
На канале Техпис говорит с Анной Костягиной вышел подкаст с одним из админов Техписалити!

О чём говорили:
- Технический писатель - он больше технический или больше писатель?
- Какие софт-навыки помогут на собеседовании.
- Какой ресурс важен при переходе из профессии в профессию. И это не курсы)
А также: о красоте гостовских текстов, немного о Техписалити!, об интровертах и экстравертах и многом другом.

Главный нетехписный инсайд встречи:
- Из какой необычной сферы деятельности пришла в IT Маша - второй админ канала Техпис говорит.
14👍3👏2
🤣38😢2🐳2
#какэтоработает

Всем привет!
Напоминаем, что сегодня в 18:00 по Москве начнётся Ozon Tech Community Techdoc Meetup

Что внутри:

😤 Маша Смирнова, Ozon Tech, расскажет о том, как принципы буддизма помогают писать документацию и где искать новые пути оптимизации работы над текстами.

💚 Анна Мария Попова из X5 Tech в своём выступлении по пунктам сравнит работу технического и художественного писателей. Узнаем, какие навыки объединяют и разнят эти сферы.

😎 Александр Мачулин, кофаундер Gramax, поделится опытом применения подхода Docs as Code со своими факапам и победами.

📍Зарегистрируйтесь, чтобы получить ссылку на трансляцию.
Please open Telegram to view this post
VIEW IN TELEGRAM
104👌3🎉2
😁31👏5
#выпуск 11
Всем привет!
🔆Неожиданно в рубрике Выпуск у нас не просто пост, а информация о вакансии для начинающих.

Озон (да-да, именно там работает Маша) набирает ❗️джунов и причём рассматривают даже без опыта работы.

Вы часто спрашивали, куда возьмут без опыта - вот он ответ)

😉Откликаться на Ozon Job или HH.
Please open Telegram to view this post
VIEW IN TELEGRAM
🔥13👍72
#какэтоработает
Всем привет!
Мы любим свой текст, потому что он - наш. А правки не любим, потому что они - чужие. Сегодня пост про то, как предложить правки и сделать их любимыми:


Правила обратной связи

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

1️⃣ Уважение. Относитесь к автору текста как к равному. Не оскорбляйте и не переходите на личности. Негативные формулировки нам не нравятся, ведь так? Они не только расстраивают, но и убивают мотивацию. Немотивированные сотрудники - это проблема, особенно если вы их руководитель.

🤓"Чё, Ильяхова не судьба почитать?"

2️⃣ Конструктивность. Аргумент “потому что я так сказал” в правках не подходит. Объясните, почему вы считаете что-то неверным, дайте возможность автору ответить на ваши замечания. Что это даст:

*️⃣ Автор поймёт, что не так и почему не так и, возможно, в следующий раз ошибку не повторит.
*️⃣Вы поймёте, чего не знает автор, какие стороны в нём нужно развить.

😎 “Нет”.
О, это реальная правка, которую я получала) Спасëт ли она меня от повторной ошибки? Да я даже не понимаю, в чëм ошиблась!

Бывает, что момент неоднозначный и допускает разные варианты, которые в своей пользе равные. Например, возьмём пустяковое: какой знак препинания нужен в конце пунктов списка. Или посложнее: какие типы статей должна включать документация, если у автора - только туториалы. Зафиксируйте договорённости.

😏"Я создал мерж реквест в редполитику, что думаешь?"

3️⃣ Сбалансированность. Постоянно указывать на проблемные места, как и постоянно хвалить, - плохо. В первом случае сотрудник может впасть в уныние, а во втором - угодить в застой и зазвездиться. Поэтому критикуйте конструктивно и не забывайте отметить то, что у сотрудника получилось блестяще. Только будьте искренними.

😍"Там в первом абзаце поправить надо, а так все отлично. У тебя хороший стиль, читается легко!"

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

☀️Кстати, про ложку. Однажды мой бывший тимлид сказал: “Помнишь, несколько месяцев назад я попросил тебя сделать задачу в пятницу, а ты сделала в понедельник?”
Я в этот момент: *с трудом вспоминаю, что было вчера*.
Please open Telegram to view this post
VIEW IN TELEGRAM
18🤝4😁2👍1🤔1
😢24😭10💔9😁4
🥰238😢6👍2😁2
Техписалити!
Всем привет! Мы приготовили для вас интерактивную учебную ролевую игру. Её цель — посмотреть, как мыслят коллеги-технические писатели, а новичкам дать наглядное представление о том, что можно ожидать от профессии: от трудностей до решений. Суть: у нас есть…
Всем привет!

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

Часть 2. Пенелопа делает первые шаги

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

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

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

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

Руководитель команды ушёл в отпуск за день до того, как прилетела эта задача. Его заместитель, самый опытный технический писатель из команды, сказал, что нужно всё бросать и писать пользовательскую документацию.

#Пенелопа_ищет_икигай #невыдуманныеистории
10🤯6🔥2
#мемница

С наступающим Новым годом, друзья! Пусть документация подольше остаётся актуальной!
🔥36😁21🎉11💯3🍾1
#выпуск 12
С наступившим, друзья!

Как говорит Маша, новогодние салаты доедены, кто-то врывается в рабочие будни, а кто-то лениво в них заползает. Не стоит сильно забивать себе голову чем-то супер полезным, а лучше следовать правилу “Новый год — новая жизнь” :)

Поэтому я (Лида) зову в свою команду технического писателя, нового, никто не уходил)


Плюсы:
Интересный проект: Kubernetes+мониторинг. Это работа, которая поднимет вашу стоимость на рынке труда.
Команда готова обучать. Покажите, насколько вы классные, и специальный человек поможет вам влиться в проект.
Зп выше средней по Москве, а если вы покорите сердце и мозг руководителя, сможете претендовать на желаемую сумму.

Минусы:
Вы будете в команде один. Но коллеги из других проектов всегда помогут, а я буду сопровождать на протяжении всего испытательного срока. Если, наоборот, хотите самостоятельности - тоже пожалуйста)

Переходите в опрос и оставьте свои контакты в форме. До встречи!
Please open Telegram to view this post
VIEW IN TELEGRAM
👍12🔥2🤝21👏1
Всем привет!

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

Что это такое?
Лучшие практики — они же best practices — это набор принципов и приёмов, которые делают продукт топовым. Это действует для любой сферы, даже для документации!

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

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

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

📌 Быть в курсе трендов.
Если в 2024 году ваша документация будет выглядеть как из 2004, в этом не будет ничего хорошего.

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

Поделимся несколькими ссылками с красивой и классной документацией:
https://angular.dev/
https://learning.postman.com/docs/
https://www.tarantool.io/ru/doc/latest/

А теперь ваша очередь делиться классной документаций в комментариях ✍️

Upd: третью ссылку заменили, спасибо за участие!❤️
#писалитирекомендует
Please open Telegram to view this post
VIEW IN TELEGRAM
23👍3🏆1
😁32👍4🎉2
#писалитирекомендует

Всем привет!
Мы сегодня к вам с полезностями.


1️⃣ Для техписателей, которые работают с текстами интерфейсов, Озон подготовил гайд по UX-текстам. Конкретно не весь Озон, а команда Киры Калимулиной. За что ей большое спасибо)

2️⃣ Всем, кто работает с текстами, напоминаем про сборник редполитик и справочников. Их можно почитать, а некоторые рекомендации — использовать.

3️⃣Ещё рекомендуем собрание редполитик и гайдов Владимира Лалоша для Плавучей редакции.

Хороших выходных😉
Please open Telegram to view this post
VIEW IN TELEGRAM
👍28🔥8🤔21
😁27🤣9😢4
#инглишлангуаге

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

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

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

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

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

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

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

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

А впереди вас еще ждет подборка того, что полезно почитать, если пишешь на английском 😉
17🔥75👍2
#мемница
Когда просишь разработчика помочь с документацией
😁56💯3🤝2
#инглишлангуаге

Всем привет!

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

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

📑 Статьи на хабре от 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: блог о редактуре ИТ/медпереводов, техписательстве и обучении переводчиков - тут, кажется, и так всё понятно)

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