Поскольку Ozon уже есть не только в России, то и Справки мы пишем не только на русском 😎
На хабре есть статья о том, на каких рельсах мы пишем доки: Делаем документацию здорового человека в Git на примере Docs Ozon
C момента публикации ничего радикально не поменялось в инструменте, а вот стран для локализации прибавилось😅
У Hugo SSG есть коробочная работа с языками, но проблема в том, что просто перевести недостаточно.
Например, для пользователей из Казахстана достаточно Справки на русском языке. А вот сама информация будет отличаться. Например, другие провайдеры доставки или самое простое — там, где для России мы пишем «почта России», для Казахстана будет «СДЭК», но при этом остальной текст будет одинаковым и для РФ, и для Казахстана.
Такое переиспользование мы сделали на кастомных шорткодах Hugo — внутри шорткода мы указываем страну, для которой надо отображать ту или иную информацию. Это может быть одно слово, абзац или целая статья.
В итоге мы смотрим какую страну выбрал пользователь и показываем только актуальную для него информацию.
А первой идеей было просто написать Справку для каждой страны отдельно😵💫
На хабре есть статья о том, на каких рельсах мы пишем доки: Делаем документацию здорового человека в Git на примере Docs Ozon
C момента публикации ничего радикально не поменялось в инструменте, а вот стран для локализации прибавилось
У Hugo SSG есть коробочная работа с языками, но проблема в том, что просто перевести недостаточно.
Например, для пользователей из Казахстана достаточно Справки на русском языке. А вот сама информация будет отличаться. Например, другие провайдеры доставки или самое простое — там, где для России мы пишем «почта России», для Казахстана будет «СДЭК», но при этом остальной текст будет одинаковым и для РФ, и для Казахстана.
Такое переиспользование мы сделали на кастомных шорткодах Hugo — внутри шорткода мы указываем страну, для которой надо отображать ту или иную информацию. Это может быть одно слово, абзац или целая статья.
В итоге мы смотрим какую страну выбрал пользователь и показываем только актуальную для него информацию.
А первой идеей было просто написать Справку для каждой страны отдельно
Please open Telegram to view this post
VIEW IN TELEGRAM
🔥9🥰3👌2
Локализация и перевод
Локализация текста и его перевод — два понятия, которые часто путают между собой
Локализация текста — это адаптация контента культурной и языковой среде конкретной аудитории. В ходе локализации не только происходит перевод текста на другой язык, но и учитываются все особенности и нюансы местной культуры. Например, это может включать замену изображений, иконок, цветовой палитры, адаптацию форматирования дат и времени, введение местных единиц измерения etc.
Перевод текста подразумевает просто передачу значения одного языка на другой. Он не учитывает контекст и культурные особенности, а сконцентрирован на точном и адекватном переводе смысла. Здесь важна грамматическая и лингвистическая точность.
Итого, разница между локализацией текста и переводом в том, что локализация учитывает культурные особенности, в то время как при переводе акцент смещается на точный перевод.
#sponsored_by_AI
Локализация текста и его перевод — два понятия, которые часто путают между собой
Локализация текста — это адаптация контента культурной и языковой среде конкретной аудитории. В ходе локализации не только происходит перевод текста на другой язык, но и учитываются все особенности и нюансы местной культуры. Например, это может включать замену изображений, иконок, цветовой палитры, адаптацию форматирования дат и времени, введение местных единиц измерения etc.
Перевод текста подразумевает просто передачу значения одного языка на другой. Он не учитывает контекст и культурные особенности, а сконцентрирован на точном и адекватном переводе смысла. Здесь важна грамматическая и лингвистическая точность.
Итого, разница между локализацией текста и переводом в том, что локализация учитывает культурные особенности, в то время как при переводе акцент смещается на точный перевод.
#sponsored_by_AI
👍10👨💻2❤1
Есть один монтажёр — Джордан Орм
У него есть много крутых работ и ещё больше крутых реакций на к-поп клипы😄
Чтобы узнать, что такого в этих ваших к-поп видео — просто посмотрите разборы от Джордана
Например, мои любимые ITZY — Cake или Stray Kids — S-Class☺️
Хинт: чтобы смотреть видео на YouTube с переводом Алисы — используйте Яндекс.Браузер и фичу "Перевести видео" 🥺
У него есть много крутых работ и ещё больше крутых реакций на к-поп клипы
Чтобы узнать, что такого в этих ваших к-поп видео — просто посмотрите разборы от Джордана
Например, мои любимые ITZY — Cake или Stray Kids — S-Class
Please open Telegram to view this post
VIEW IN TELEGRAM
🔥3😍2
Сегодня я к вам с анонсом
✨ У нас открывается вакансия✨
В отдел технических писателей Ozon Tech ищем специалиста со знанием английского языка🐈
Человек нужен на задачи по документациям для зарубежных пользователей. Но у нас есть и API, и внутренности разработки Ozon — можно переключаться и изучать что-то новое🐣
Гарантируем docs-as-code, вычитки и отсутствие ГОСТов🐱
Резюме можно слать мне в личку — @ushkatia💌
✨ У нас открывается вакансия✨
В отдел технических писателей Ozon Tech ищем специалиста со знанием английского языка
Человек нужен на задачи по документациям для зарубежных пользователей. Но у нас есть и API, и внутренности разработки Ozon — можно переключаться и изучать что-то новое
Гарантируем docs-as-code, вычитки и отсутствие ГОСТов
Резюме можно слать мне в личку — @ushkatia
Please open Telegram to view this post
VIEW IN TELEGRAM
🔥9❤4😱2🤩1
Ещё анонс-напоминание
15-16 сентября в Ульяновске
👉 Стачка 2023 👈
и я
с докладом о документационной базе
чтобы купить билет со скидкой 10%, укажите промокод «Ушакова»
15-16 сентября в Ульяновске
и я
с докладом о документационной базе
Please open Telegram to view this post
VIEW IN TELEGRAM
❤🔥6🤩5👨💻1
Видеоинструкции
В последние годы всё больше и больше людей предпочитают получать информацию в виде видео вместо текстовых инструкций. Вполне логично — видео нагляднее, живее и позволяет эффективнее передавать информацию. Как говорят, картинка говорит больше слов.
Тем не менее, помимо явных преимуществ, есть и неочевидные минусы использования видео в инструкциях для пользователей.
Первое и, пожалуй, самое значимое — видео труднее и сложнее редактировать, чем тексты. Редактирование текста для обновления информации или исправления ошибок может проходить гораздо быстрее и проще, чем редактирование видео. Опять же, требуется наличие определенных навыков и специальных программ для работы с видео редакторами.
Кроме того, видео неудобно для быстрого поиска нужной информации. В отличие от текста, который можно быстро просканировать или воспользоваться поиском по ключевым словам, видео требует просмотра с самого начала до конца. Если пользователь ищет ответ на конкретный вопрос или нуждается только в части информации, видео может стать неэффективным способом получения нужной информации.
Также не стоит забывать о том, что видео обычно имеют больший размер и качество, что может затруднить их загрузку и потреблять больше интернет-трафика. Это может быть особенно проблематично для пользователей с медленным интернетом или с ограниченным трафиком.
И, наконец, стоит учитывать предпочтения пользователей. Некоторые люди предпочитают читать текстовые инструкции, поскольку они могут быстро сканировать текст, выделять ключевые моменты и возвращаться к нужной информации в любой момент. Они также могут читать инструкции на своем родном языке, не завися от наличия аудио или субтитров.
Таким образом, ответ на вопрос, стоит ли использовать видео в инструкциях для пользователей, не является однозначным. Это зависит от конкретной ситуации и предпочтений вашей целевой аудитории. В некоторых случаях видео может быть наиболее эффективным и удобным способом передачи информации, а в других — текстовые инструкции могут быть более предпочтительными. Важно подходить к выбору формата инструкции с учетом потребностей и возможностей пользователей.
#sponsored_by_AI
ps, вот в этот раз я только дефисы на длинные тире заменила, остальное ИИ сам написал. пора открывать курсы по формулированию запросов к чат-жпт?)
В последние годы всё больше и больше людей предпочитают получать информацию в виде видео вместо текстовых инструкций. Вполне логично — видео нагляднее, живее и позволяет эффективнее передавать информацию. Как говорят, картинка говорит больше слов.
Тем не менее, помимо явных преимуществ, есть и неочевидные минусы использования видео в инструкциях для пользователей.
Первое и, пожалуй, самое значимое — видео труднее и сложнее редактировать, чем тексты. Редактирование текста для обновления информации или исправления ошибок может проходить гораздо быстрее и проще, чем редактирование видео. Опять же, требуется наличие определенных навыков и специальных программ для работы с видео редакторами.
Кроме того, видео неудобно для быстрого поиска нужной информации. В отличие от текста, который можно быстро просканировать или воспользоваться поиском по ключевым словам, видео требует просмотра с самого начала до конца. Если пользователь ищет ответ на конкретный вопрос или нуждается только в части информации, видео может стать неэффективным способом получения нужной информации.
Также не стоит забывать о том, что видео обычно имеют больший размер и качество, что может затруднить их загрузку и потреблять больше интернет-трафика. Это может быть особенно проблематично для пользователей с медленным интернетом или с ограниченным трафиком.
И, наконец, стоит учитывать предпочтения пользователей. Некоторые люди предпочитают читать текстовые инструкции, поскольку они могут быстро сканировать текст, выделять ключевые моменты и возвращаться к нужной информации в любой момент. Они также могут читать инструкции на своем родном языке, не завися от наличия аудио или субтитров.
Таким образом, ответ на вопрос, стоит ли использовать видео в инструкциях для пользователей, не является однозначным. Это зависит от конкретной ситуации и предпочтений вашей целевой аудитории. В некоторых случаях видео может быть наиболее эффективным и удобным способом передачи информации, а в других — текстовые инструкции могут быть более предпочтительными. Важно подходить к выбору формата инструкции с учетом потребностей и возможностей пользователей.
#sponsored_by_AI
ps, вот в этот раз я только дефисы на длинные тире заменила, остальное ИИ сам написал. пора открывать курсы по формулированию запросов к чат-жпт?)
❤9👍3🆒1
статья от коллеги о техписцах 🦄
пишите в тред свои вопросы о профессии, инструментах, процессах и о чём угодно ещё🐣
пишите в тред свои вопросы о профессии, инструментах, процессах и о чём угодно ещё
Please open Telegram to view this post
VIEW IN TELEGRAM
🔥9
Записки зануды
https://academy.yandex.ru/journal/technicheskii-pisatel Дописала😌
кто успел — тот посмотрел)
кто не успел — ждём пока статью немного поправят и вернут🤔
кто не успел — ждём пока статью немного поправят и вернут
Please open Telegram to view this post
VIEW IN TELEGRAM
😱6
Понедельник! 👨💻
И у меня есть для вас видео:
Is Success Luck or Hard Work?
тема из подборки моих любимых на поспорить😈
Как считаете — существует ли удача в принципе?
#monday_link
И у меня есть для вас видео:
Is Success Luck or Hard Work?
тема из подборки моих любимых на поспорить
Как считаете — существует ли удача в принципе?
#monday_link
Please open Telegram to view this post
VIEW IN TELEGRAM
YouTube
Is Success Luck or Hard Work?
In a competitive world, tiny advantages can make all the difference. Get 10% off Snatoms with code 'giveluck' in the US: https://ve42.co/USA or International: https://snatoms.com
If you would like to receive Snatoms, submit the form here: https://ve42.co/getluck…
If you would like to receive Snatoms, submit the form here: https://ve42.co/getluck…
❤3🏆2
#анонс
Techdoc Meetup 2
28 сентября онлайн и офлайн
Расскажем о стайлгайдах, поговорим о роли техписателя в продуктовых компаниях🐸
Регистрируйтесь, присылайте вопросы в тред, приходите в Москве🐸
Techdoc Meetup 2
28 сентября онлайн и офлайн
Расскажем о стайлгайдах, поговорим о роли техписателя в продуктовых компаниях
Регистрируйтесь, присылайте вопросы в тред, приходите в Москве
Please open Telegram to view this post
VIEW IN TELEGRAM
❤15🤝3🤩2
Ушакова — директор буковок
Понедельник! 👨💻 И у меня есть для вас видео: Is Success Luck or Hard Work? тема из подборки моих любимых на поспорить 😈 Как считаете — существует ли удача в принципе? #monday_link
Моё мнение, что доля неопределённости в мире определённо существует. И что в какой-то момент какие-то обстоятельства могут "удачно сложиться".
Но не механизм ли это нашей психики? Я уверена, что мы считываем и анализируем гораздо больше, чем осознаём.
Ещё я уверена, что если человек не готов, то никакие случайности ему не помогут в долгой перспективе.
И ещё факт, что люди склонны возводить воздушные замки и не замечать слона в комнате.
Поэтому и ценны те, кто научился адаптировать свой опыт под новые обстоятельства и разворачивать ситуацию "удачной" стороной🍀
Но не механизм ли это нашей психики? Я уверена, что мы считываем и анализируем гораздо больше, чем осознаём.
Ещё я уверена, что если человек не готов, то никакие случайности ему не помогут в долгой перспективе.
И ещё факт, что люди склонны возводить воздушные замки и не замечать слона в комнате.
Поэтому и ценны те, кто научился адаптировать свой опыт под новые обстоятельства и разворачивать ситуацию "удачной" стороной
Please open Telegram to view this post
VIEW IN TELEGRAM
👍6🤓2🤔1
Техническая документация может быть скучной и сложной для понимания. Но с помощью архетипов карт Таро, можно сделать её более интересной и доступной для всех.
Проанализируем, как можно использовать архетипы карт Таро на примерах для создания полезной и понятной технической документации
Техническая документация часто страдает от сухости и отсутствия эмоций. Можно добавить эмоциональную окраску в документацию и привлечь внимание читателей, используя архетипы из мира карт Таро.
Вместо того, чтобы просто описывать функционал продукта, вы можете использовать аркан Маг, символизирующий мудрость и внутреннюю силу, для создания более эмоциональной связи с читателем. Расскажите историю, как ваш продукт может помочь пользователю раскрыть свои таланты и достичь успеха.
Часто словесные описания технической информации могут быть сложными для понимания. Однако, с использованием архетипов карт Таро, можно создать примеры и аналогии, которые делают информацию более доступной.
Аркан Башня символизирует конфликт и разрушение. Вы можете использовать этот аркан для создания примера, объясняющего потенциальные проблемы или ошибки в использовании продукта. Такой пример поможет пользователям лучше понять, как избежать этих проблем и правильно использовать продукт.
Добавление изображений с символами и образами из мира карт Таро может помочь читателю запомнить информацию и лучше усвоить её.
Добавьте в документацию иллюстрации карт Таро, которые иллюстрируют ключевые концепции или шаги. Это поможет читателю лучше усвоить информацию и в последующем легче вспомнить её.
#sponsored_by_AI
Как вам идея?) уже ставите тикет на своего техписателя?
Please open Telegram to view this post
VIEW IN TELEGRAM
🤔6🗿4🔥3🤡1
Больше полезного о документации — сегодня на Стачке и 28 сентября на Techdoc Meetup 2
Сегодня рассказываю очень базовые вещи о документации — что такое, какая бывает, как пишется🍄
На техдоке Арина расскажет об атрибутах: стайлгайдах, глоссариях, ToV и шаблонах🍄
Да и в целом сезон конференций открыт, следите за анонсами, задавайте свои вопросы в тредах🍄
Сегодня рассказываю очень базовые вещи о документации — что такое, какая бывает, как пишется
На техдоке Арина расскажет об атрибутах: стайлгайдах, глоссариях, ToV и шаблонах
Да и в целом сезон конференций открыт, следите за анонсами, задавайте свои вопросы в тредах
Please open Telegram to view this post
VIEW IN TELEGRAM
❤9👍4🔥2
Please open Telegram to view this post
VIEW IN TELEGRAM
YouTube
Gentle Rain 🌧 Calm Your Anxiety, Relaxing Music - Lofi Hip Hop Mix- Aesthetic Lofi
🎧 Listen on Spotify - https://spoti.fi/3fNpOgA
Gentle Rain 🌧 Calm Your Anxiety, Relaxing Music - Lofi Hip Hop Mix- Aesthetic Lofi
➤ More Lofi music on Spotify playlist: https://spoti.fi/2XMnYq2
💕✨Help me reach 200,000 subscribers: 💕: bit.ly/AestheticLofi_Subscribe…
Gentle Rain 🌧 Calm Your Anxiety, Relaxing Music - Lofi Hip Hop Mix- Aesthetic Lofi
➤ More Lofi music on Spotify playlist: https://spoti.fi/2XMnYq2
💕✨Help me reach 200,000 subscribers: 💕: bit.ly/AestheticLofi_Subscribe…
❤6😇3
Немного вброшу про ретроспективы 🌸
Ретро — регулярные встречи команды ради анализа проделанной работы
Формат ретро, его регулярность, его необходимость в принципе остаётся на усмотрение команд — здесь как с любым фреймворком — посмотрели, померили, выбрали самое полезное.
Ретро можно поделить на 4 этапа:
🐶 разогрев
📌 позитивное
📌 негативное
📌 план действий
Не буду разбирать подробно, хочу сейчас об одном моменте.
Позитивное-негативное можно обсуждать с вопроса "что было хорошо или плохо?". Но можно подойти с другого ракурса:
Что нам стоит продолжить и что надо прекратить делать?
Мы перешли на такую формулировку и я заметила, что команда фокусируется на совсем других вещах. Коллеги начали больше думать о конкретных ситуациях и процессах, а не тянуть из ретро в ретро вещи вне нашего влияния.
💭 Как относитесь к ретро? Что можете порекомендовать из вашей практики?
Ретро — регулярные встречи команды ради анализа проделанной работы
Формат ретро, его регулярность, его необходимость в принципе остаётся на усмотрение команд — здесь как с любым фреймворком — посмотрели, померили, выбрали самое полезное.
Ретро можно поделить на 4 этапа:
Не буду разбирать подробно, хочу сейчас об одном моменте.
Позитивное-негативное можно обсуждать с вопроса "что было хорошо или плохо?". Но можно подойти с другого ракурса:
Что нам стоит продолжить и что надо прекратить делать?
Мы перешли на такую формулировку и я заметила, что команда фокусируется на совсем других вещах. Коллеги начали больше думать о конкретных ситуациях и процессах, а не тянуть из ретро в ретро вещи вне нашего влияния.
Please open Telegram to view this post
VIEW IN TELEGRAM
🔥9❤🔥2🤓1
Вытаскиваем знания из эксперта
Хороший вопрос был на Стачке про добычу информации из её держателей.
Если вам нужна индульгенция на иглы, утюги и паяльники — уточните у работодателя)
Но!
Да, бывают сложные коллеги, да, бывает сложное знание, да, бывают завалы и не до ответов на странные вопросы.
Мне кажется, это вопрос приоритетов. Иногда командных, иногда — конкретного человека.
Поэтому
1️⃣ Объясните человеку, зачем оно надо. Не “потому что мне задачу поставили”, а чуть дальше. “Чтобы тебе с такими вопросами больше не приходили”, например.
2️⃣ Договоритесь об удобном канале связи. Я обычно предлагаю такие форматы:
*️⃣ регулярная встреча на 15 минут и вопросы к ней за сутки;
*️⃣ отдельная страница или чат с вопросами от меня, куда человек будет заходить в комфортное для него время и письменно отвечать;
*️⃣ контакт кого-то из команды, кто может ответить на большинство вопросов или передать на обсуждение дальше, чтобы вернуться и ответить.
3️⃣ Обозначьте сроки и границы задачи, чтобы человек понимал как долго и по каким вопросам вы будете приходить.
Ну и выдерживайте гигиену коммуникаций
Хороший вопрос был на Стачке про добычу информации из её держателей.
Да, бывают сложные коллеги, да, бывает сложное знание, да, бывают завалы и не до ответов на странные вопросы.
Мне кажется, это вопрос приоритетов. Иногда командных, иногда — конкретного человека.
Поэтому
Ну и выдерживайте гигиену коммуникаций
Please open Telegram to view this post
VIEW IN TELEGRAM
👍13👌3🙏1
Какие видео чаще пропускаете и не смотрите?
Anonymous Poll
34%
Кружочки
44%
Сториз
29%
Вертикальные в канале
56%
По ссылке на YouTube
3%
Свой вариант
#monday_link
Роль текста в продукте от Академии Яндекса
Лекция на полтора часа в основном о редакторах, но с наглядными примерами по очень разным темам — и интерфейсы, и FAQ✨
Там же о текстовых атрибутах, даже для соцсетей🔥
🤨 Лекции и доклады оставляем или это как раз те ютубные ссылки, которые скипаются?)
Роль текста в продукте от Академии Яндекса
Лекция на полтора часа в основном о редакторах, но с наглядными примерами по очень разным темам — и интерфейсы, и FAQ
Там же о текстовых атрибутах, даже для соцсетей
Please open Telegram to view this post
VIEW IN TELEGRAM
YouTube
Работа с копирайтером — Ксения Витюк
Обсудим, как менеджерам работать с редакторами, какие тексты — хорошие, а какие не очень, и как организовать командную работу над проектом, чтобы тексты всегда получались.
❤7👍4👌2
Гигиена коммуникаций
Начинайте чат с представления.
Привет! Я из отдела технических писателей.
Указывайте источник обращения.
В чате ~helpdesk направили к тебе.
Насыпайте контекста.
У нас есть платформа документации docs.ozon.ru. Сейчас она вся доступна из внешней сети.
Описывайте запрос и ожидаемый результат.
Нам надо скрыть часть статей. Например, Способы оплаты. Так, чтобы если я пытаюсь перейти на эту страницу не из рабочей сети, то получала страницу 404. Список таких статей на скрытие есть в тикете.
Оставляйте пути отступления.
Подскажи, это к тебе? Или к кому лучше обратиться?)
Уважайте процессы других команд.
Куда занести задачу и какой процесс приоритизации?
Обозначьте риски и ограничения.
Задача не срочная, есть время до 1 ноября.
🍊 Пример грубый, поэтому бонусное правило.
Заботьтесь о коллегах
пишите это всё в одном сообщении
Начинайте чат с представления.
Привет! Я из отдела технических писателей.
Указывайте источник обращения.
В чате ~helpdesk направили к тебе.
Насыпайте контекста.
У нас есть платформа документации docs.ozon.ru. Сейчас она вся доступна из внешней сети.
Описывайте запрос и ожидаемый результат.
Нам надо скрыть часть статей. Например, Способы оплаты. Так, чтобы если я пытаюсь перейти на эту страницу не из рабочей сети, то получала страницу 404. Список таких статей на скрытие есть в тикете.
Оставляйте пути отступления.
Подскажи, это к тебе? Или к кому лучше обратиться?)
Уважайте процессы других команд.
Куда занести задачу и какой процесс приоритизации?
Обозначьте риски и ограничения.
Задача не срочная, есть время до 1 ноября.
Заботьтесь о коллегах
Please open Telegram to view this post
VIEW IN TELEGRAM
❤25👍5💯3
уже сегодня techdoc meetup 2 📥
поговорим о стайлгайдах и о профессии техписателя — подключайтесь к трансляции в 19:00▶️
📌 UPD Запись митапа
поговорим о стайлгайдах и о профессии техписателя — подключайтесь к трансляции в 19:00
Please open Telegram to view this post
VIEW IN TELEGRAM
🔥8👌1