#технические_писатели — Public Fediverse posts

Синергия дизайнеров и техписов: создание единых стандартов Tone of voice

Привет, Хабр! Меня зовут Саша Новицкая, я ведущий дизайнер продукта в Х5 Tech. Занимаюсь B2B продуктами и дизайн-системой. Хочу рассказать о том, как мы вместе с техническими писателями разрабатывали и дорабатывали наш ToV (Tone of Voice). И даже поделимся результатом нашей работы в виде гайда. А помогать мне в этом будет мой соавтор и менеджер направления «Разработки технической документации» Х5 Tech Настя Московкина . Мы проделали эту работу год назад, но только сейчас созрели написать статью об этом. Дисклеймер: чтение этой статьи может затронуть чьи-то чувства или описать ситуации, которые противоречат вашему мнению. Мы, авторы, не претендуем на истинность наших высказываний. Вы также можете поделиться своим мнением в комментариях.

https://habr.com/ru/companies/X5Tech/articles/831344/

#tone_of_voice #редполитика #styleguide #дизайнсистема #ux_writing #дизайнеры #техписы #технические_писатели #ui/ux_дизайн

Синергия дизайнеров и техписов: создание единых стандартов Tone of voice

Привет, Хабр! Меня зовут Саша Новицкая, я ведущий дизайнер продукта в Х5 Tech. Занимаюсь B2B продуктами и дизайн-системой. Хочу рассказать о том, как мы вместе с техническими писателями разрабатывали и дорабатывали наш ToV (Tone of Voice). И даже поделимся результатом нашей работы в виде гайда. А помогать мне в этом будет мой соавтор и менеджер направления «Разработки технической документации» Х5 Tech Настя Московкина . Мы проделали эту работу год назад, но только сейчас созрели написать статью об этом. Дисклеймер: чтение этой статьи может затронуть чьи-то чувства или описать ситуации, которые противоречат вашему мнению. Мы, авторы, не претендуем на истинность наших высказываний. Вы также можете поделиться своим мнением в комментариях.

https://habr.com/ru/companies/X5Tech/articles/831344/

#tone_of_voice #редполитика #styleguide #дизайнсистема #ux_writing #дизайнеры #техписы #технические_писатели #ui/ux_дизайн

Синергия дизайнеров и техписов: создание единых стандартов Tone of voice

Привет, Хабр! Меня зовут Саша Новицкая, я ведущий дизайнер продукта в Х5 Tech. Занимаюсь B2B продуктами и дизайн-системой. Хочу рассказать о том, как мы вместе с техническими писателями разрабатывали и дорабатывали наш ToV (Tone of Voice). И даже поделимся результатом нашей работы в виде гайда. А помогать мне в этом будет мой соавтор и менеджер направления «Разработки технической документации» Х5 Tech Настя Московкина . Мы проделали эту работу год назад, но только сейчас созрели написать статью об этом. Дисклеймер: чтение этой статьи может затронуть чьи-то чувства или описать ситуации, которые противоречат вашему мнению. Мы, авторы, не претендуем на истинность наших высказываний. Вы также можете поделиться своим мнением в комментариях.

https://habr.com/ru/companies/X5Tech/articles/831344/

#tone_of_voice #редполитика #styleguide #дизайнсистема #ux_writing #дизайнеры #техписы #технические_писатели #ui/ux_дизайн

5 причин, почему пользователи терпеть ненавидят вашу документацию [и как это исправить]

«Ваша документация — отстой!», «Я её никогда не читаю, всё равно там ерунда написана!», «Эти документаторы опять всё напутали», «Да любая нейросеть быстро напишет всё это в сто раз лучше», «Там никогда не найти ничего нужного», «А разве у нас есть документация?»... Обратная связь от читателей-пользователей далеко не всегда бывает конструктивной и вдохновляющей. Почему же так получается? Маловероятно, что кто-то из технических писателей хочет специально выдать плохой документ. Скорее наоборот — авторы изо всех сил стараются, чтобы документация была полезной, понятной и удобной. Но, несмотря на все усилия, идеальный результат получается далеко не всегда. Давайте разберём пять основных претензий читателей к технической документации, и подумаем, что со всем этим делать.

https://habr.com/ru/articles/811461/

#документация #документация_кода #документация_проекта #технические_писатели #документирование #пользовательская_документация #технология_единого_источника #проверка_документации #техническая_документация #обратная_связь

СТОИКИ, visibility, ИПР и другие «витамины роста». 9+ ключевых советов про карьеру от техписов

На прошлой неделе мы в «Лаборатории Касперского» провели онлайн-митап, в рамках которого спикеры из различных компаний рассмотрели карьеру технического писателя как со стороны самого сотрудника (профессиональное развитие, выход на повышение, шифтинг в смежную специальность), так и со стороны нанимающих менеджеров (как найти стажера, как грамотно сформулировать требования к кандидату, как выстроить систему адаптации и что делать, если команда резко увеличилась). Здесь в посте — краткая выжимка эфира в девяти ключевых тезисах, собранных из докладов всех спикеров. Если же вам интересно послушать полные выступления, а также ответы на волнующие зрителей (и, скорее всего, вас тоже) вопросы, посмотрите запись митапа по этой ссылке или в виджете ниже. Тем более что часть тезисов о развитии, повышении и структурных изменениях в команде будет применима не только к разработке документации, но и к другим сферам.

https://habr.com/ru/companies/kaspersky/articles/800319/

#программирование #разработка #оптимизация #производительность #документация #техническая_документация #технический_писатель #confluence #документирование #база_знаний #технические_писатели #стандарты #софт #карьера #работа #карьера_в_it #карьера_в_itиндустрии #itкомпании #карьера_итспециалиста #hr #персонал #управление_людьми #сотрудники #управление_командой #управление_персоналом #собеседование #обучение #образование #курсы #учебный_процесс #учебный_процесс_в_it

Приглашаем на онлайновый митап про карьеру техписа: наём, развитие, треки

В среду, 6 марта, в 16 часов (МСК) мы проведем онлайновый митап под названием « Kaspersky Tech Fest. Карьера техписа: наём, развитие, треки ». Спикерами митапа будут технические писатели, а также тимлиды команд техписов и руководители отделов технической документации из топовых компаний. Коллеги рассмотрят карьеру и развитие технического писателя с разных сторон: от поиска и адаптации нового сотрудника (включая стажера без опыта) до источников профессионального роста и возможностей повышения.

https://habr.com/ru/companies/kaspersky/articles/795071/

#программирование #разработка #оптимизация #производительность #документация #техническая_документация #технический_писатель #confluence #документирование #база_знаний #технические_писатели #стандарты #софт #карьера #работа #карьера_в_it #карьера_в_itиндустрии #itкомпании #карьера_итспециалиста #hr #персонал #управление_людьми #сотрудники #управление_командой #управление_персоналом #собеседование #обучение #образование #курсы #учебный_процесс #учебный_процесс_в_it

17 вредных советов для тех, кто проверяет документацию и технические тексты

Вы пишете документацию, статьи или другие тексты? Тогда, наверняка, у вас есть проверяющие. Я уверен, что вы нежно и трепетно любите своих проверяющих. Вы, скорее всего, с нетерпением ждёте, когда они пришлют вам свои правки и комментарии. Благоговейно изучаете и перечитываете крупицы мудрости, которыми проверяющие благосклонно поделились с вами. Лучшие из комментариев вы записываете в специальную тетрадочку или даже распечатываете и вешаете их на стену... Я начал коллекционировать самые фееричные комментарии. Делал я это для того, чтобы иметь перед глазами антипример — как ни в коем случае нельзя писать комментарии к текстам. Эти советы — тщательно отобранные, систематизированные и дистиллированные советы для проверяющих. Практическое руководство по доведению до белого каления ваших технических писателей и авторов. Дисклеймер. Все совпадения фрагментов этого текста с реальными комментариями в вашей документации совершенно случайны. При написании этого текста не пострадал ни один проверяющий.

https://habr.com/ru/articles/811321/

#документация #техническая_документация #разработка_документации #проверка_документации #комментарии #правки #технические_писатели #авторы

17 вредных советов для тех, кто проверяет документацию и технические тексты

Вы пишете документацию, статьи или другие тексты? Тогда, наверняка, у вас есть проверяющие. Я уверен, что вы нежно и трепетно любите своих проверяющих. Вы, скорее всего, с нетерпением ждёте, когда они пришлют вам свои правки и комментарии. Благоговейно изучаете и перечитываете крупицы мудрости, которыми проверяющие благосклонно поделились с вами. Лучшие из комментариев вы записываете в специальную тетрадочку или даже распечатываете и вешаете их на стену... Я начал коллекционировать самые фееричные комментарии. Делал я это для того, чтобы иметь перед глазами антипример — как ни в коем случае нельзя писать комментарии к текстам. Эти советы — тщательно отобранные, систематизированные и дистиллированные советы для проверяющих. Практическое руководство по доведению до белого каления ваших технических писателей и авторов. Дисклеймер. Все совпадения фрагментов этого текста с реальными комментариями в вашей документации совершенно случайны. При написании этого текста не пострадал ни один проверяющий.

https://habr.com/ru/articles/811321/

#документация #техническая_документация #разработка_документации #проверка_документации #комментарии #правки #технические_писатели #авторы

17 вредных советов для тех, кто проверяет документацию и технические тексты

Вы пишете документацию, статьи или другие тексты? Тогда, наверняка, у вас есть проверяющие. Я уверен, что вы нежно и трепетно любите своих проверяющих. Вы, скорее всего, с нетерпением ждёте, когда они пришлют вам свои правки и комментарии. Благоговейно изучаете и перечитываете крупицы мудрости, которыми проверяющие благосклонно поделились с вами. Лучшие из комментариев вы записываете в специальную тетрадочку или даже распечатываете и вешаете их на стену... Я начал коллекционировать самые фееричные комментарии. Делал я это для того, чтобы иметь перед глазами антипример — как ни в коем случае нельзя писать комментарии к текстам. Эти советы — тщательно отобранные, систематизированные и дистиллированные советы для проверяющих. Практическое руководство по доведению до белого каления ваших технических писателей и авторов. Дисклеймер. Все совпадения фрагментов этого текста с реальными комментариями в вашей документации совершенно случайны. При написании этого текста не пострадал ни один проверяющий.

https://habr.com/ru/articles/811321/

#документация #техническая_документация #разработка_документации #проверка_документации #комментарии #правки #технические_писатели #авторы

17 вредных советов для тех, кто проверяет документацию и технические тексты

Вы пишете документацию, статьи или другие тексты? Тогда, наверняка, у вас есть проверяющие. Я уверен, что вы нежно и трепетно любите своих проверяющих. Вы, скорее всего, с нетерпением ждёте, когда они пришлют вам свои правки и комментарии. Благоговейно изучаете и перечитываете крупицы мудрости, которыми проверяющие благосклонно поделились с вами. Лучшие из комментариев вы записываете в специальную тетрадочку или даже распечатываете и вешаете их на стену... Я начал коллекционировать самые фееричные комментарии. Делал я это для того, чтобы иметь перед глазами антипример — как ни в коем случае нельзя писать комментарии к текстам. Эти советы — тщательно отобранные, систематизированные и дистиллированные советы для проверяющих. Практическое руководство по доведению до белого каления ваших технических писателей и авторов. Дисклеймер. Все совпадения фрагментов этого текста с реальными комментариями в вашей документации совершенно случайны. При написании этого текста не пострадал ни один проверяющий.

https://habr.com/ru/articles/811321/

#документация #техническая_документация #разработка_документации #проверка_документации #комментарии #правки #технические_писатели #авторы

Почему светофор важнее Шекспира? Про примечания в технических текстах

У химиков есть известная байка, которую они любят рассказывать молодому поколению. Главный герой этой истории — студент, который пошагово воспроизводил методику одного химического эксперимента из учебника. Он старательно выполнил очередной шаг «добавьте азотную кислоту» и... в лаборатории прогремел взрыв! Когда впоследствии стали разбираться, в чём же дело, выяснилось, что на следующей странице учебника было написано: «... медленно, по каплям». Примечания и уточнения — очень важный элемент любого технического и научного текста. В любом документе фрагменты текста можно ранжировать по важности и критичности излагаемых сведений. Бывает просто обычный текст, который течёт себе ровно, как спокойная равнинная река. Бывают фрагменты с дополнительной, необязательной, уточняющей информацией: автору хотелось их добавить в текст, но они плохо укладываются в основную логику изложения материала. А ещё бывают критичные замечания и уточнения, которые обязательно должны быть обвешаны мигающими сигнальными огнями, сиренами, хлопушками и прочими средствами привлечения внимания читателя. Как же лучше оформлять примечания в технических текстах? В статье расскажу вам про пять несложных правил оформления примечаний и уточнений в технических текстах.

https://habr.com/ru/articles/822145/

#примечания #примечания_к_техническим_текстам #техническая_документация #примечания_к_документации #уточнения #правила_оформления_примечаний #технические_тексты #пользовательская_документация #светофор #технические_писатели

«Чем занимается ваша команда?», или как дайджесты могут решать командные проблемы на примере технических писателей
В этой статье я разберу на примере команды технических писателей, как решить проблему "невидимости" работы команды с помощью новостных дайджестов. Статья будет полезна командам, которые хотят стать более открытыми для коллег из соседних подразделений, а также для более эффективного и прозрачного взаимодействия с заказчиками.
#единый_цупис #цупис #дайджест #команда #управление_командой #техническая_документация #технические_писатели #взаимодействие_с_заказчиком
https://habr.com/ru/companies/1cupis/articles/774632/

Почему светофор важнее Шекспира? Про примечания в технических текстах

У химиков есть известная байка, которую они любят рассказывать молодому поколению. Главный герой этой истории — студент, который пошагово воспроизводил методику одного химического эксперимента из учебника. Он старательно выполнил очередной шаг «добавьте азотную кислоту» и... в лаборатории прогремел взрыв! Когда впоследствии стали разбираться, в чём же дело, выяснилось, что на следующей странице учебника было написано: «... медленно, по каплям». Примечания и уточнения — очень важный элемент любого технического и научного текста. В любом документе фрагменты текста можно ранжировать по важности и критичности излагаемых сведений. Бывает просто обычный текст, который течёт себе ровно, как спокойная равнинная река. Бывают фрагменты с дополнительной, необязательной, уточняющей информацией: автору хотелось их добавить в текст, но они плохо укладываются в основную логику изложения материала. А ещё бывают критичные замечания и уточнения, которые обязательно должны быть обвешаны мигающими сигнальными огнями, сиренами, хлопушками и прочими средствами привлечения внимания читателя. Как же лучше оформлять примечания в технических текстах? В статье расскажу вам про пять несложных правил оформления примечаний и уточнений в технических текстах.

https://habr.com/ru/articles/822145/

#примечания #примечания_к_техническим_текстам #техническая_документация #примечания_к_документации #уточнения #правила_оформления_примечаний #технические_тексты #пользовательская_документация #светофор #технические_писатели

Почему светофор важнее Шекспира? Про примечания в технических текстах

У химиков есть известная байка, которую они любят рассказывать молодому поколению. Главный герой этой истории — студент, который пошагово воспроизводил методику одного химического эксперимента из учебника. Он старательно выполнил очередной шаг «добавьте азотную кислоту» и... в лаборатории прогремел взрыв! Когда впоследствии стали разбираться, в чём же дело, выяснилось, что на следующей странице учебника было написано: «... медленно, по каплям». Примечания и уточнения — очень важный элемент любого технического и научного текста. В любом документе фрагменты текста можно ранжировать по важности и критичности излагаемых сведений. Бывает просто обычный текст, который течёт себе ровно, как спокойная равнинная река. Бывают фрагменты с дополнительной, необязательной, уточняющей информацией: автору хотелось их добавить в текст, но они плохо укладываются в основную логику изложения материала. А ещё бывают критичные замечания и уточнения, которые обязательно должны быть обвешаны мигающими сигнальными огнями, сиренами, хлопушками и прочими средствами привлечения внимания читателя. Как же лучше оформлять примечания в технических текстах? В статье расскажу вам про пять несложных правил оформления примечаний и уточнений в технических текстах.

https://habr.com/ru/articles/822145/

#примечания #примечания_к_техническим_текстам #техническая_документация #примечания_к_документации #уточнения #правила_оформления_примечаний #технические_тексты #пользовательская_документация #светофор #технические_писатели

5 причин, почему пользователи терпеть ненавидят вашу документацию [и как это исправить]

«Ваша документация — отстой!», «Я её никогда не читаю, всё равно там ерунда написана!», «Эти документаторы опять всё напутали», «Да любая нейросеть быстро напишет всё это в сто раз лучше», «Там никогда не найти ничего нужного», «А разве у нас есть документация?»... Обратная связь от читателей-пользователей далеко не всегда бывает конструктивной и вдохновляющей. Почему же так получается? Маловероятно, что кто-то из технических писателей хочет специально выдать плохой документ. Скорее наоборот — авторы изо всех сил стараются, чтобы документация была полезной, понятной и удобной. Но, несмотря на все усилия, идеальный результат получается далеко не всегда. Давайте разберём пять основных претензий читателей к технической документации, и подумаем, что со всем этим делать.

https://habr.com/ru/articles/811461/

#документация #документация_кода #документация_проекта #технические_писатели #документирование #пользовательская_документация #технология_единого_источника #проверка_документации #техническая_документация #обратная_связь

5 причин, почему пользователи терпеть ненавидят вашу документацию [и как это исправить]

«Ваша документация — отстой!», «Я её никогда не читаю, всё равно там ерунда написана!», «Эти документаторы опять всё напутали», «Да любая нейросеть быстро напишет всё это в сто раз лучше», «Там никогда не найти ничего нужного», «А разве у нас есть документация?»... Обратная связь от читателей-пользователей далеко не всегда бывает конструктивной и вдохновляющей. Почему же так получается? Маловероятно, что кто-то из технических писателей хочет специально выдать плохой документ. Скорее наоборот — авторы изо всех сил стараются, чтобы документация была полезной, понятной и удобной. Но, несмотря на все усилия, идеальный результат получается далеко не всегда. Давайте разберём пять основных претензий читателей к технической документации, и подумаем, что со всем этим делать.

https://habr.com/ru/articles/811461/

#документация #документация_кода #документация_проекта #технические_писатели #документирование #пользовательская_документация #технология_единого_источника #проверка_документации #техническая_документация #обратная_связь