Заметки с митапа Write the docs London
Курсы от Google📝
Об авторе: Шариф Салах (Sharif Salah) старший технический писатель в Google.
В компании Google уже несколько лет проходят курсы на которых любой сотрудник может научиться писать техническую документацию. Курс состоит из двух модулей, участники пишут тексты и обсуждают их друг с другом.
И так эта идея заходит, что курсы планируют запустить во вне Google. Ищут волонтеров-учителей, пока только English (ссылочка на группу).
Но никто не мешает нам сделать свой курс на русском!
Имхо зачем все это?
Эти курсы не про прокачать техписовский навык, они скорее про продвижение хорошего стиля документации и вообще идеи документации. В компаниях очень нужна документация, если про внешнюю еще хоть как-то вспоминают, то про внутреннюю редко. Например, курсы будут полезны разработчикам, которые хотят писать документацию для своих решений, ну или начать писать внятные комментарии к коду, из которых потом можно нагенерить документацию.
Если вы технический писатель и думаете, что сейчас разработчики научатся писать документацию и вы будете не нужны, то нет:)
#вестникмитапов
Курсы от Google📝
Об авторе: Шариф Салах (Sharif Salah) старший технический писатель в Google.
В компании Google уже несколько лет проходят курсы на которых любой сотрудник может научиться писать техническую документацию. Курс состоит из двух модулей, участники пишут тексты и обсуждают их друг с другом.
И так эта идея заходит, что курсы планируют запустить во вне Google. Ищут волонтеров-учителей, пока только English (ссылочка на группу).
Но никто не мешает нам сделать свой курс на русском!
Имхо зачем все это?
Эти курсы не про прокачать техписовский навык, они скорее про продвижение хорошего стиля документации и вообще идеи документации. В компаниях очень нужна документация, если про внешнюю еще хоть как-то вспоминают, то про внутреннюю редко. Например, курсы будут полезны разработчикам, которые хотят писать документацию для своих решений, ну или начать писать внятные комментарии к коду, из которых потом можно нагенерить документацию.
Если вы технический писатель и думаете, что сейчас разработчики научатся писать документацию и вы будете не нужны, то нет:)
#вестникмитапов
Заметки с митапа Write the docs London
Глобализация в документации Люси Кэри (Lucy Carey)🌏
Об авторе: Люси писатель, редактор и переводчик на японский, она работала с контентом на всех этапах от написания документа до его перевода и публикации. Сейчас работает специалистом по контенту в компании Anaplan.
Локализация и перевод
Локализация и перевод — разные вещи. Перевод — это шифр к сейфу, для каждого сейфа есть только один подходящий код, а для каждого слова — есть слово-перевод. Локализация — это взлом супер крутой системы в банке, вокруг лазеры и сложные датчики, вы можете пройти разными способами, а каждое слова можно перевести по-разному в зависимости от ситуации.
Как можно переводить
* Человек. У вас должен быть человек, который знает два языка на уровне нейтива (как родной), желательно давно живет в стране, для которой вы готовите контент.
* Машина. Машины переводят очень быстро, а еще они с каждым годом переводят все лучше и лучше. Но они не научились говорить и писать как люди. За ними приходится много проверять.
* Человек+машина. Например, память переводов (translation memory), которые хранят уже переведенные фрагменты и подсказывают их переводчику.
Что нужно учитывать при планировании переводов
* Календарь. Для перевода нужно время, это время нужно добавить ко времени, которое вы тратите на подготовку контента. Ведь плохо, если версии документации на разных языках расходятся.
* UX. Если вы работаете с пользователями из разных культур, то для них UX может быть разный. Например, вещи, которые очевидны для европейского рынка, могут быть непонятны азиатскому и нужны будут дополнительные объяснения.
* Доступность. Не забывайте про текстовое описание к диаграммам, субтитры к видео и другие вещи, которые сделают контент доступным для любых пользователей.
* Медиа. Картинки, скриншоты, видео, диаграммы и другая медиа информация должна быть локализована. Это еще дополнительное время и затраты.
* Проверка терминов. Вы можете определенным образом переводить слово, использовать специфические термины, и важно, чтобы они совпадали во всех материалах.
На что еще уходит время при локализации
* Баг в интерфейсе. Когда доходит до перевода, тексты интерфейсов править уже поздно. Особенно если текст уже согласовали менеджер, маркетинг и все-все. Поправить и пересогласовать сложно. Например, в Европе нормально предлагать пользователям поспешить, у нас постоянно нужно делать быстрее и успевать больше. В Японии, для которой мы готовим перевод, это неуместно и очень грубо. Но текст уже готов и согласован, про его локализацию в момент написания никто не думал. Для решения этой проблемы, подключайте переводчиков в момент согласования текста.
* Погружение в мир пользователя. Проверяйте, что пользователь на всех этапах увидит только переведенный текст. Простого решения тут нет, только проверка руками.
* Посредники не готовы. При переводах нужно учитывать время работы ваших посредников, у них могут быть другие праздники и выходные.
* Миссия невыполнима. Нельзя просто так взять и начать переводить на еще один язык. Это дорого и требует времени на подготовку.
Как сократить затраты на перевод
Ускорить локализацию помогает хорошая документация, хороший изначальный текст.
Цитата Джона Бергера (John Berger):
Сделать текст лучше поможет правило снека:
Sensible headers (Подходящие заголовки)
No figurative or idiomatic language (Без метафор и идиом)
Active language (Активный залог)
Consistency (Единообразно)
Keep punctuation to a minimum (С минимумом пунктуации)
#вестникмитапов
Глобализация в документации Люси Кэри (Lucy Carey)🌏
Об авторе: Люси писатель, редактор и переводчик на японский, она работала с контентом на всех этапах от написания документа до его перевода и публикации. Сейчас работает специалистом по контенту в компании Anaplan.
Локализация и перевод
Локализация и перевод — разные вещи. Перевод — это шифр к сейфу, для каждого сейфа есть только один подходящий код, а для каждого слова — есть слово-перевод. Локализация — это взлом супер крутой системы в банке, вокруг лазеры и сложные датчики, вы можете пройти разными способами, а каждое слова можно перевести по-разному в зависимости от ситуации.
Как можно переводить
* Человек. У вас должен быть человек, который знает два языка на уровне нейтива (как родной), желательно давно живет в стране, для которой вы готовите контент.
* Машина. Машины переводят очень быстро, а еще они с каждым годом переводят все лучше и лучше. Но они не научились говорить и писать как люди. За ними приходится много проверять.
* Человек+машина. Например, память переводов (translation memory), которые хранят уже переведенные фрагменты и подсказывают их переводчику.
Что нужно учитывать при планировании переводов
* Календарь. Для перевода нужно время, это время нужно добавить ко времени, которое вы тратите на подготовку контента. Ведь плохо, если версии документации на разных языках расходятся.
* UX. Если вы работаете с пользователями из разных культур, то для них UX может быть разный. Например, вещи, которые очевидны для европейского рынка, могут быть непонятны азиатскому и нужны будут дополнительные объяснения.
* Доступность. Не забывайте про текстовое описание к диаграммам, субтитры к видео и другие вещи, которые сделают контент доступным для любых пользователей.
* Медиа. Картинки, скриншоты, видео, диаграммы и другая медиа информация должна быть локализована. Это еще дополнительное время и затраты.
* Проверка терминов. Вы можете определенным образом переводить слово, использовать специфические термины, и важно, чтобы они совпадали во всех материалах.
На что еще уходит время при локализации
* Баг в интерфейсе. Когда доходит до перевода, тексты интерфейсов править уже поздно. Особенно если текст уже согласовали менеджер, маркетинг и все-все. Поправить и пересогласовать сложно. Например, в Европе нормально предлагать пользователям поспешить, у нас постоянно нужно делать быстрее и успевать больше. В Японии, для которой мы готовим перевод, это неуместно и очень грубо. Но текст уже готов и согласован, про его локализацию в момент написания никто не думал. Для решения этой проблемы, подключайте переводчиков в момент согласования текста.
* Погружение в мир пользователя. Проверяйте, что пользователь на всех этапах увидит только переведенный текст. Простого решения тут нет, только проверка руками.
* Посредники не готовы. При переводах нужно учитывать время работы ваших посредников, у них могут быть другие праздники и выходные.
* Миссия невыполнима. Нельзя просто так взять и начать переводить на еще один язык. Это дорого и требует времени на подготовку.
Как сократить затраты на перевод
Ускорить локализацию помогает хорошая документация, хороший изначальный текст.
Цитата Джона Бергера (John Berger):
«Настоящий перевод — это не просто бинарное соответствие между двумя языками, это трехстороннее взаимодействие. Третья точка — это то, что лежало за словами оригинального текста, до того, как он был написан.» (Полный текст)Сделать текст лучше поможет правило снека:
Sensible headers (Подходящие заголовки)
No figurative or idiomatic language (Без метафор и идиом)
Active language (Активный залог)
Consistency (Единообразно)
Keep punctuation to a minimum (С минимумом пунктуации)
#вестникмитапов
А тем временем в России
27 ноября — вебинар сообщества Women in Localization про юридические тонкости трудоустройства. Расскажут про ИП и самозанятых, про официальное трудоустройство в штат и особенности первой работы, про работу с иностранными компаниями и валютный контроль.
29 ноября — митап Positive CAT tools battle. Расскажут про SDL Trados Studio, Memsource, Smartcat и memoQ. Если вы только выбираете себе систему для перевода, то спешите видеть. Москва, обещали трансляцию.
2 декабря — митап для UX-писателей / UX-редакторов (aka для людей, которые пишут текст для интерфейса). Санкт-Петербург, надеюсь на трансляцию.
Все мероприятия бесплатные, но нужна регистрация 🤑
#вестникмитапов
27 ноября — вебинар сообщества Women in Localization про юридические тонкости трудоустройства. Расскажут про ИП и самозанятых, про официальное трудоустройство в штат и особенности первой работы, про работу с иностранными компаниями и валютный контроль.
29 ноября — митап Positive CAT tools battle. Расскажут про SDL Trados Studio, Memsource, Smartcat и memoQ. Если вы только выбираете себе систему для перевода, то спешите видеть. Москва, обещали трансляцию.
2 декабря — митап для UX-писателей / UX-редакторов (aka для людей, которые пишут текст для интерфейса). Санкт-Петербург, надеюсь на трансляцию.
Все мероприятия бесплатные, но нужна регистрация 🤑
#вестникмитапов
Что посмотреть на выходных
Очень вовремя опубликовали записи докладов с первого митапа UX-редакторов в «Яндекс Деньгах»:
* Сколько нужно редакторов, чтобы вкрутить смысл. Таша Гермогентова, Лид-редактор (UX) «Яндекс Деньги»
* Как разобрать 200 штрафов и не умереть. Евгений Лёфквист, UX-писатель «Сбербанк»
* Сколько стоит плохой текст. Маргарита Хохлова, Контент-стратег Profi.ru
И еще про UX-тексты пара старых видео:
* UX-проектировщик и UX-писатель. Посередине менеджер. Ольга Табачишина, менеджер проектов КБ «Собака Павлова»
* UX-писательство. Как автор текстов помогает дизайнерам улучшить интерфейсы.
Дмитрий Макаров, UX-писатель КБ «Собака Павлова»
* Текст в интерфейсах. Александр Бурт, проектировщик интерфейсов
#вестникмитапов
Очень вовремя опубликовали записи докладов с первого митапа UX-редакторов в «Яндекс Деньгах»:
* Сколько нужно редакторов, чтобы вкрутить смысл. Таша Гермогентова, Лид-редактор (UX) «Яндекс Деньги»
* Как разобрать 200 штрафов и не умереть. Евгений Лёфквист, UX-писатель «Сбербанк»
* Сколько стоит плохой текст. Маргарита Хохлова, Контент-стратег Profi.ru
И еще про UX-тексты пара старых видео:
* UX-проектировщик и UX-писатель. Посередине менеджер. Ольга Табачишина, менеджер проектов КБ «Собака Павлова»
* UX-писательство. Как автор текстов помогает дизайнерам улучшить интерфейсы.
Дмитрий Макаров, UX-писатель КБ «Собака Павлова»
* Текст в интерфейсах. Александр Бурт, проектировщик интерфейсов
#вестникмитапов
Adobe DITAWORLD 2020
Опубликованы доклады с конференции Adobe.
Для меня самыми интересными были:
- Beyond the OT. Sarah O’Keefe, CEO at Scriptorium
О том, можно ли из DITA OT получить что-то кроме стандартных PDF и HTML. Например, InDesign, PowerPoint или JSON.
- Customer Experiences – Powered by AI. Elliot Sedegah, Group Product Marketing Manager Adobe
Как можно упростить работу с контентом с помощью AI и что это изменит. Примеры: можно изменять контент под разные форматы и выделять основные слова из текста статьи и использовать их для тегов к статье.
- DITA, where art thou?. Kristen James Eberlein, OASIS DITA Technical Committee
Про жизненный путь архитектуры DITA и планы на будущее (DITA 2.0 и Lightweight DITA).
#вестникмитапов
Опубликованы доклады с конференции Adobe.
Для меня самыми интересными были:
- Beyond the OT. Sarah O’Keefe, CEO at Scriptorium
О том, можно ли из DITA OT получить что-то кроме стандартных PDF и HTML. Например, InDesign, PowerPoint или JSON.
- Customer Experiences – Powered by AI. Elliot Sedegah, Group Product Marketing Manager Adobe
Как можно упростить работу с контентом с помощью AI и что это изменит. Примеры: можно изменять контент под разные форматы и выделять основные слова из текста статьи и использовать их для тегов к статье.
- DITA, where art thou?. Kristen James Eberlein, OASIS DITA Technical Committee
Про жизненный путь архитектуры DITA и планы на будущее (DITA 2.0 и Lightweight DITA).
#вестникмитапов
Adobeevents
Adobe DITAWORLD 2020 | The Recordings
The world’s biggest DITA Online Conference for Marketing & Technical Communication Professionals
Всемирный день информационной архитектуры
Ежегодно в феврале проходит всемирный день информационной архитектуры. Информационная архитектура — термин со множеством определений. Можно говорить, что информационная архитектура — это декомпозиция и структура контента, например, так говорят про информационную архитектуру DITA. Можно говорить, что это способ, которым мы упорядочиваем части чего-то, чтобы сделать его понятным, как в книге How to Make Sense of Any Mess. Эти определения друг друга не исключают, они смотрят с разных сторон.
27 февраля онлайн пройдет World IA Day London 2021. Тема этого года «Curiosity».
Про что будем говорить:
- Использование дизайн-мышления для улучшения MVP (Ioannis Nousis, Interaction Designer at Google)
- Внедрение CI/CD для публикации документации (David Bailey, Information Architect at Snyk)
- От хаотического контента к хорошо сбалансированному графу контента (Dr Ian Piper, Owner of Tellura Semantics)
- Системное мышление на практике (Bryn Ray, Consultant, Experience Transformation at American Express)
- Peter Morville (соавтор книги по Information Architecture for the World Wide Web)
- John V Willshire (cоздатель smithery.com и изобретатель артефактных карт)
Участие бесплатно, зарегистрироваться можно по ссылке. Митапы в других городах можно найти на сайте WIAD.
#вестникмитапов
Ежегодно в феврале проходит всемирный день информационной архитектуры. Информационная архитектура — термин со множеством определений. Можно говорить, что информационная архитектура — это декомпозиция и структура контента, например, так говорят про информационную архитектуру DITA. Можно говорить, что это способ, которым мы упорядочиваем части чего-то, чтобы сделать его понятным, как в книге How to Make Sense of Any Mess. Эти определения друг друга не исключают, они смотрят с разных сторон.
27 февраля онлайн пройдет World IA Day London 2021. Тема этого года «Curiosity».
Про что будем говорить:
- Использование дизайн-мышления для улучшения MVP (Ioannis Nousis, Interaction Designer at Google)
- Внедрение CI/CD для публикации документации (David Bailey, Information Architect at Snyk)
- От хаотического контента к хорошо сбалансированному графу контента (Dr Ian Piper, Owner of Tellura Semantics)
- Системное мышление на практике (Bryn Ray, Consultant, Experience Transformation at American Express)
- Peter Morville (соавтор книги по Information Architecture for the World Wide Web)
- John V Willshire (cоздатель smithery.com и изобретатель артефактных карт)
Участие бесплатно, зарегистрироваться можно по ссылке. Митапы в других городах можно найти на сайте WIAD.
#вестникмитапов