Приветствую вас на канале, посвященном разным полезностям для начинающего технического писателя.
Канал будет полезен и для тех, кому нужно обучить и вырастить младшего технического писателя.
Вам точно будет полезно и интересно, когда у вас есть хороший человек, которого нужно обучить как новичка с нуля.
Плюс гостей подкаста просто интересно слушать.
Upd, 16.08.2023
У нас есть три рубрики #подкаст
#встречазнакомство - первая встреча с техписателем
#мастеркласс - тематическая встреча от техписателя, с которым уже была встреча-знакомство.
#МоскваКультурная - офлайн-встреча с техписателем на художественных выставках
Upd, 31.01.2024
Теперь 6 рубрик - добавились еще эти:
#тема - подкаст со спикером на определенную тему, как правило уже после встречи-знакомства
#СпросиСпикера - пост для сбора вопросов спикеру перед предстоящим подкастом с ним
#саунддизайн - надеюсь иногда рассказывать о звуке и саунд дизайне
Канал будет полезен и для тех, кому нужно обучить и вырастить младшего технического писателя.
Вам точно будет полезно и интересно, когда у вас есть хороший человек, которого нужно обучить как новичка с нуля.
Плюс гостей подкаста просто интересно слушать.
Upd, 16.08.2023
У нас есть три рубрики #подкаст
#встречазнакомство - первая встреча с техписателем
#мастеркласс - тематическая встреча от техписателя, с которым уже была встреча-знакомство.
#МоскваКультурная - офлайн-встреча с техписателем на художественных выставках
Upd, 31.01.2024
Теперь 6 рубрик - добавились еще эти:
#тема - подкаст со спикером на определенную тему, как правило уже после встречи-знакомства
#СпросиСпикера - пост для сбора вопросов спикеру перед предстоящим подкастом с ним
#саунддизайн - надеюсь иногда рассказывать о звуке и саунд дизайне
Итак, начнем.
Когда вы единственный технический писатель в компании - это расклад один, а когда у вас появляется помощник - это расклад совсем другой.
Что происходит в начале?
Онбординг
Происходит адаптация нового сотрудника.
Скорость его погружения в тему и освоения всего нового, льющегося на него потоками водопада Виктория, потрясает вас обоих и завораживает своей активностью и мощью.
Ты как старший хранитель тайного знания самоотверженно обучаешь новичка и со всей строгостью контролируешь его прогресс.
Ты выкладываешься по полной и требуешь того же от своего подопечного.
"Холодно ли тебе, девица? Холодно ли тебе, красная?" - как Морозко спрашиваешь ты в 22ч о готовности часик поучиться. И в ответ, ты эту готовность получаешь, и работаешь. Хотя вы оба прекрасно знаете, что да еще как "холодно" - за затянувшийся рабочий день устали все, но у вас очень сжатые сроки.
Спустя два месяца, когда ты обучил новичка с нуля до какого-то базового уровня, ты выдыхаешь.
Знаешь, что вот, ты надежно подготовил новичка, который теперь справится с базовыми задачами на вполне достойном уровне.
Когда проходит три месяца, ты уже настолько привык к напарнику, что кажется странным, что его когда-то у тебя не было. Да, непроизвольно ты относишься к нему уже не просто как к помощнику, а уже помощнику-напарнику.
И тут ты начинаешь требовать от него больше.
И тебя начинает крыть, когда ты видишь, что человек выполнил все не так, тебе кажется все таким нелепым. Но ты сразу берешь себя в руки и задаешь себе свой список вопросов:
1. А ты получил обратную связь, когда поставил задачу?
2. Ты помнишь, что человек делает это в первый раз?
3. А ты прописал это в твоем стаилгайде и выслал ссылку?
4. Когда ты привел примеры и выслал нужные файлы, ты все акценты расставил и проконтролировал, что все правильно понято?
Если тут есть хотя бы одно "нет", делаешь себе пометки, что именно добавить в стаилгайд.
Стаилгайд
Ваш персональный гид по стилю внутри вашей команды.
Думаю, наглядно объяснила, зачем он нужен.
Прописываем в нем весь опыт, вытекающий из подобных ситуаций.
Фиксируем там все по процессу, стилю и оформлению, все нюансы и обычаи команды.
Даже если тебе это кажется очевидным.
Не зафиксировал - считай, не сказал.
Когда вы единственный технический писатель в компании - это расклад один, а когда у вас появляется помощник - это расклад совсем другой.
Что происходит в начале?
Онбординг
Происходит адаптация нового сотрудника.
Скорость его погружения в тему и освоения всего нового, льющегося на него потоками водопада Виктория, потрясает вас обоих и завораживает своей активностью и мощью.
Ты как старший хранитель тайного знания самоотверженно обучаешь новичка и со всей строгостью контролируешь его прогресс.
Ты выкладываешься по полной и требуешь того же от своего подопечного.
"Холодно ли тебе, девица? Холодно ли тебе, красная?" - как Морозко спрашиваешь ты в 22ч о готовности часик поучиться. И в ответ, ты эту готовность получаешь, и работаешь. Хотя вы оба прекрасно знаете, что да еще как "холодно" - за затянувшийся рабочий день устали все, но у вас очень сжатые сроки.
Спустя два месяца, когда ты обучил новичка с нуля до какого-то базового уровня, ты выдыхаешь.
Знаешь, что вот, ты надежно подготовил новичка, который теперь справится с базовыми задачами на вполне достойном уровне.
Когда проходит три месяца, ты уже настолько привык к напарнику, что кажется странным, что его когда-то у тебя не было. Да, непроизвольно ты относишься к нему уже не просто как к помощнику, а уже помощнику-напарнику.
И тут ты начинаешь требовать от него больше.
И тебя начинает крыть, когда ты видишь, что человек выполнил все не так, тебе кажется все таким нелепым. Но ты сразу берешь себя в руки и задаешь себе свой список вопросов:
1. А ты получил обратную связь, когда поставил задачу?
2. Ты помнишь, что человек делает это в первый раз?
3. А ты прописал это в твоем стаилгайде и выслал ссылку?
4. Когда ты привел примеры и выслал нужные файлы, ты все акценты расставил и проконтролировал, что все правильно понято?
Если тут есть хотя бы одно "нет", делаешь себе пометки, что именно добавить в стаилгайд.
Стаилгайд
Ваш персональный гид по стилю внутри вашей команды.
Думаю, наглядно объяснила, зачем он нужен.
Прописываем в нем весь опыт, вытекающий из подобных ситуаций.
Фиксируем там все по процессу, стилю и оформлению, все нюансы и обычаи команды.
Даже если тебе это кажется очевидным.
Не зафиксировал - считай, не сказал.
🔥4❤2👍2👏1
Техпис говорит | Подкасты
Прошла курс по технической документации в IT-проектах #техпис #курс #advanced_technical_writing
Благодарна ведущему курса и всем участникам.
Курс помог систематизировать свои знания, получить новые, узнать, что стоит взять на заметку и почитать.
Главным на курсе для меня было живое обсуждение и практическая работа вместе с другими участниками.
Мне было очень приятно, что со мной вместе учились на курсе такие крутые технические писатели из других компаний.
Ребята, я очень рада знакомству с вами!
Сам курс подарил мне уверенность.
Важно было узнать, что у тебя хороший уровень, узнать разные полезности и получить вдохновение.
Зовите на курс по документированию API :)
Спасибо!
#отзыв #учеба #курс #техническийписатель
Курс помог систематизировать свои знания, получить новые, узнать, что стоит взять на заметку и почитать.
Главным на курсе для меня было живое обсуждение и практическая работа вместе с другими участниками.
Мне было очень приятно, что со мной вместе учились на курсе такие крутые технические писатели из других компаний.
Ребята, я очень рада знакомству с вами!
Сам курс подарил мне уверенность.
Важно было узнать, что у тебя хороший уровень, узнать разные полезности и получить вдохновение.
Зовите на курс по документированию API :)
Спасибо!
#отзыв #учеба #курс #техническийписатель
Анонс на следующую неделю
Книга:
Профессия технический писатель, или Рыцари клавиатуры
Автор:
Михайлов Александр Владимирович
ISBN
978-5-9519-2720-0
Обсуждаем книгу и ее полезности.
Листайте, присоединяйтесь к обсуждениям, делитесь запомнившимися лайфхаками.
#книги #РыцариКлавиатуры
Книга:
Профессия технический писатель, или Рыцари клавиатуры
Автор:
Михайлов Александр Владимирович
ISBN
978-5-9519-2720-0
Обсуждаем книгу и ее полезности.
Листайте, присоединяйтесь к обсуждениям, делитесь запомнившимися лайфхаками.
#книги #РыцариКлавиатуры
Привет, друзья!
Меня зовут Анна. Мы с моей подругой Марией записали цикл подкастов по книге Александра Михайлова "...Рыцари клавиатуры..." Все реквизиты книги есть в предыдущем посте.
В наших беседах обучаю подругу основам работы технического писателя.
По мотивам содержания книги объясняю подруге все на своих практических примерах с акцентом на том, что считаю применимым и полезным для нас.
Меня зовут Анна. Мы с моей подругой Марией записали цикл подкастов по книге Александра Михайлова "...Рыцари клавиатуры..." Все реквизиты книги есть в предыдущем посте.
В наших беседах обучаю подругу основам работы технического писателя.
По мотивам содержания книги объясняю подруге все на своих практических примерах с акцентом на том, что считаю применимым и полезным для нас.
Рыцари_клавиатуры_Беседа_по_главе_1_Часть_1-[AudioTrimmer.com]
<unknown>
Подкаст. Рыцари клавиатуры. Беседы по книге. Глава 1. Часть 1.
7 минут
#РыцариКлавиатуры #подкаст #обсуждение_книги
7 минут
#РыцариКлавиатуры #подкаст #обсуждение_книги
Рыцари_клавиатуры_Беседа_по_главе_1_Часть_2-[AudioTrimmer.com]
<unknown>
Подкаст. Рыцари клавиатуры. Беседы по книге. Глава 1. Часть 2
55 минут
#РыцариКлавиатуры #подкаст #обсуждение_книги
55 минут
#РыцариКлавиатуры #подкаст #обсуждение_книги
Техпис говорит | Подкасты
<unknown> – Рыцари_клавиатуры_Беседа_по_главе_1_Часть_2-[AudioTrimmer.com]
Небольшие дополнения к подкасту по Главе 1.
Там были озвучены вопросы, детали которых мы не вспомнили в эфире.
Но уже все уточнили:
1. Оказалось, что у Маши квалификация - журналист, специальность - журналистика.
А у меня - экономист / финансы и кредит.
И мы обе прошли обучение на разных курсах по Тестированию ПО, прежде чем стать техническими писателями.
2. Единственный успешный технический писатель из официальных писателей, по прошлогоднему мнению Семена, ведущего курса, - это американский писатель Курт Воннегут-младший (1922-2007). Но это просто его альтернативное мнение)
Там были озвучены вопросы, детали которых мы не вспомнили в эфире.
Но уже все уточнили:
1. Оказалось, что у Маши квалификация - журналист, специальность - журналистика.
А у меня - экономист / финансы и кредит.
И мы обе прошли обучение на разных курсах по Тестированию ПО, прежде чем стать техническими писателями.
2. Единственный успешный технический писатель из официальных писателей, по прошлогоднему мнению Семена, ведущего курса, - это американский писатель Курт Воннегут-младший (1922-2007). Но это просто его альтернативное мнение)
👍1
Новые каналы техписов. Пересылаю из дружественного сайта позитивных экспертов-техписов
https://t.me/technicalwriters
https://t.me/technicalwriters
Telegram
Технические писатели
Чат технических писателей. Обсуждаем работу и делимся знаниями.
Вход через бота: @captcha_tw_bot
Как устроен чат: https://t.me/technicalwriters/202128
Правила: https://t.me/technicalwriters/170079
Создан 17 марта 2017 года
Вход через бота: @captcha_tw_bot
Как устроен чат: https://t.me/technicalwriters/202128
Правила: https://t.me/technicalwriters/170079
Создан 17 марта 2017 года
❤2
Forwarded from Nick Volynkin
Итого, у нас сегодня три новых техписательских канала.
@lidalidit
@techwritersays
@Techwriters_Diary
Про старые тоже не забываем
@shut_up_and_write
@the_know_all
@technical_writing
@rishavant
@docops
Кого забыл, пишите в личку @Nick_Volynkin
@lidalidit
@techwritersays
@Techwriters_Diary
Про старые тоже не забываем
@shut_up_and_write
@the_know_all
@technical_writing
@rishavant
@docops
Кого забыл, пишите в личку @Nick_Volynkin
🔥1
Forwarded from Razdina Daria
Приглашаем на Techdoc Meetup #1, посвященный техническим писателям, где послушаем доклады от X5 Tech, Тинькофф, Ozon.
🕠 05 июня | 18:00
🛋 Online
Встреча будет полезна техническим писателям, руководителям продуктов и всех неравнодушным, а также любому участнику команды продукта, который хочет улучшить качество документации и процесс работы с ней.
Присоединяйтесь и задавайте вопросы во время трансляции.
Программа встречи:
✏️Маргарита Жданова, техписатель в X5 Tech.
«Как мы внедрили docs-as-code в своей команде»
Маргарита расскажет про свой опыт — как ее команда перешла на docs-as-code; с чем столкнулись при переходе; почему не понравился старый инструмент — Wiki Confluence.
✏️Теодора Малевинская, старший технический писатель в Тинькофф
«Документация — не панацея, или как писать не для галочки»
Поговорим о том, почему документация — продукт, а не просто текст; как техписатели стреляют себе в ногу; почему принципы проектирования текстов и интерфейсов схожи. И, главное, почему не нужно придумывать свои правила русского языка и писать на бересте.
✏️Мария Смирнова, руководитель группы пользовательской документации в Ozon
«Translation done right: 10 принципов хорошего перевода»
Обсудим, как отличить хороший перевод от плохого, какими принципами мы при этом руководствуемся и какие инструменты используем. Подробно и с примерами из реальной жизни разберём, как это работает при переводе документации Ozon на английский, и почему мы стремимся сделать наши переводы максимально непохожими на переводы.
Трансляция будет на Youtube-канале Ozon Tech, регистрируйтесь, чтобы получить ссылку.
#встреча #событие #meetup #event
🕠 05 июня | 18:00
🛋 Online
Встреча будет полезна техническим писателям, руководителям продуктов и всех неравнодушным, а также любому участнику команды продукта, который хочет улучшить качество документации и процесс работы с ней.
Присоединяйтесь и задавайте вопросы во время трансляции.
Программа встречи:
✏️Маргарита Жданова, техписатель в X5 Tech.
«Как мы внедрили docs-as-code в своей команде»
Маргарита расскажет про свой опыт — как ее команда перешла на docs-as-code; с чем столкнулись при переходе; почему не понравился старый инструмент — Wiki Confluence.
✏️Теодора Малевинская, старший технический писатель в Тинькофф
«Документация — не панацея, или как писать не для галочки»
Поговорим о том, почему документация — продукт, а не просто текст; как техписатели стреляют себе в ногу; почему принципы проектирования текстов и интерфейсов схожи. И, главное, почему не нужно придумывать свои правила русского языка и писать на бересте.
✏️Мария Смирнова, руководитель группы пользовательской документации в Ozon
«Translation done right: 10 принципов хорошего перевода»
Обсудим, как отличить хороший перевод от плохого, какими принципами мы при этом руководствуемся и какие инструменты используем. Подробно и с примерами из реальной жизни разберём, как это работает при переводе документации Ozon на английский, и почему мы стремимся сделать наши переводы максимально непохожими на переводы.
Трансляция будет на Youtube-канале Ozon Tech, регистрируйтесь, чтобы получить ссылку.
#встреча #событие #meetup #event
ozontech.timepad.ru
Techdoc Meetup #1 / События на TimePad.ru
👍6