Привет! Ну что, пора начать историю еще одного канала технических писателей. Торжественно обещаем писать только о работе: лайфхаки, рабочие практики, околодокументационные активности, мероприятия и многое другое. Да-да, именно обещаЕМ, авторов у этого канала несколько. Попозже мы обязательно познакомимся и раскроем тайну, кто мы.
А пока расскажем, что наша великолепная четверка работает в одной классной компании c целой командой технических писателей, которая постоянно увеличивается. Мы пишем не только пользовательские инструкции, но и инструкции для поддержки, тексты в интерфейсе, сценарии и тексты для чат-ботов, рассылки.
А пока расскажем, что наша великолепная четверка работает в одной классной компании c целой командой технических писателей, которая постоянно увеличивается. Мы пишем не только пользовательские инструкции, но и инструкции для поддержки, тексты в интерфейсе, сценарии и тексты для чат-ботов, рассылки.
🎉19🍾8🏆2
Этим рабочим утром у нас для вас опрос.
Приходилось ли вам слышать от заказчиков недоумение, почему инструкции пишутся так долго?
Приходилось ли вам слышать от заказчиков недоумение, почему инструкции пишутся так долго?
Anonymous Poll
54%
О, да!
21%
Нет, обычно удивляются, что так быстро
24%
Я не техпис, просто посмотрю ответы
👍2
Технический писатель не «пишет»
Сколько времени нужно, чтобы создать страничку инструкции? Может, час, а может пару недель.
Зависит не от скорости набора букв на клавиатуре, а от того, что стоит за этой страничкой.
✅ Несколько встреч-консультаций с аналитиками или разработчиками.
✅ Самостоятельное прохождение всех сценариев на тесте или проде.
✅ Изучение рабочей документации — user story, бизнес-требования и т.д.
✅ Несколько итераций внутренней вычитки.
✅ Проверка документа заказчиком.
Так что мы говорим, что занимаемся не написанием, а разработкой технической документации. Никто же не думает, что основной рабочий процесс у разработчика — набирать буковки кода на клавиатуре? Вот и у техписов также.
И да, мы стараемся рассказывать заказчикам о нашем workflow, иначе откуда им знать. Тогда и вопросов вроде «почему так долго», которые многие из вас слышали, как показал утренний опрос, становится сильно меньше.
А как вы считаете, заказчикам нужно знать внутреннюю кухню техписов?
#давайте_про_процессы
Сколько времени нужно, чтобы создать страничку инструкции? Может, час, а может пару недель.
Зависит не от скорости набора букв на клавиатуре, а от того, что стоит за этой страничкой.
✅ Несколько встреч-консультаций с аналитиками или разработчиками.
✅ Самостоятельное прохождение всех сценариев на тесте или проде.
✅ Изучение рабочей документации — user story, бизнес-требования и т.д.
✅ Несколько итераций внутренней вычитки.
✅ Проверка документа заказчиком.
Так что мы говорим, что занимаемся не написанием, а разработкой технической документации. Никто же не думает, что основной рабочий процесс у разработчика — набирать буковки кода на клавиатуре? Вот и у техписов также.
И да, мы стараемся рассказывать заказчикам о нашем workflow, иначе откуда им знать. Тогда и вопросов вроде «почему так долго», которые многие из вас слышали, как показал утренний опрос, становится сильно меньше.
А как вы считаете, заказчикам нужно знать внутреннюю кухню техписов?
#давайте_про_процессы
💯26👍9❤2🤝1
Приглашаем на Techdoc митап #5
Как и обещали, рассказываем про долгожданное мероприятие для технических писателей. Уже слышали про серию Techdoc митап? 3 октября пройдет очередная встреча, на которой поговорим про работу в режиме аврала, автопроверки по стайлгайдам и синергию редактора, дизайнера и исследователя. А сейчас активно идут репетиции докладов, обсуждаются вопросы круглого стола.
В этот раз на круглом столе в обсуждении примут участие эксперты из X5Tech, Ozon, Яндекс.Маркета, Cloud и Лаборатории Касперского. Уверены, тема, которую мы обсудим, вдохновит вас на новые свершения на работе. Уже интересно?
Зарегистрироваться
#давайте_анонс
Как и обещали, рассказываем про долгожданное мероприятие для технических писателей. Уже слышали про серию Techdoc митап? 3 октября пройдет очередная встреча, на которой поговорим про работу в режиме аврала, автопроверки по стайлгайдам и синергию редактора, дизайнера и исследователя. А сейчас активно идут репетиции докладов, обсуждаются вопросы круглого стола.
В этот раз на круглом столе в обсуждении примут участие эксперты из X5Tech, Ozon, Яндекс.Маркета, Cloud и Лаборатории Касперского. Уверены, тема, которую мы обсудим, вдохновит вас на новые свершения на работе. Уже интересно?
Зарегистрироваться
#давайте_анонс
🔥10✍3❤2👀2
Подписываете ли вы скрины в инструкциях?
Anonymous Poll
47%
Да (расскажу в комментах, как)
42%
Нет
11%
Не добавляю скрины в инструкции
Как подписать скриншот
А нужно ли? В ГОСТ действительно их подписывают: Рис. 1 или Рисунок 1. В коммерции подписи к рисункам — большая редкость. Да и сами скриншоты вставляют нечасто.
Что делаем мы: оставляем открытыми только важные скрины, без которых пользователю будет сложно разобраться. Таких скринов остается не так много, 1-2 на страницу, и их мы никак не подписываем. А все дополнительные примеры убираем под каты. Теперь читатели, которым все понятно, читают и идут дальше. А те, у кого остались вопросы и нужны визуальные подсказки, открывают каты и смотрят.
А вот каты мы, конечно, подписываем, причем содержательно. Пользователь должен знать, что увидит при нажатии. Несколько примеров, как мы договорились подписывать каты: Посмотреть пример, Как это выглядит в интерфейсе, Где находится кнопка.
#давайте_практику
А нужно ли? В ГОСТ действительно их подписывают: Рис. 1 или Рисунок 1. В коммерции подписи к рисункам — большая редкость. Да и сами скриншоты вставляют нечасто.
Что делаем мы: оставляем открытыми только важные скрины, без которых пользователю будет сложно разобраться. Таких скринов остается не так много, 1-2 на страницу, и их мы никак не подписываем. А все дополнительные примеры убираем под каты. Теперь читатели, которым все понятно, читают и идут дальше. А те, у кого остались вопросы и нужны визуальные подсказки, открывают каты и смотрят.
А вот каты мы, конечно, подписываем, причем содержательно. Пользователь должен знать, что увидит при нажатии. Несколько примеров, как мы договорились подписывать каты: Посмотреть пример, Как это выглядит в интерфейсе, Где находится кнопка.
#давайте_практику
👍8✍6❤1🤝1
Мы собираемся на митап в четверг: слушать про авралы, автопроверки и UX. А вы?
Anonymous Poll
38%
Буду лично
40%
Буду онлайн
22%
Не смогу быть :(
Больше примечаний богу примечаний
Примечания — классный элемент верстки, ведь он позволяет выделить нужный кусочек текста, чтобы читатель точно его заметил. Но что происходит, когда примечаний слишком много, как на странице в посте? Эффект обратный. Наш мозг невольно их воспринимает как фон, а читать хочется, наоборот, небольшой фрагмент текста, который написан без сложного форматирования.
Вот что важно соблюдать, чтобы примечания работали:
✅ Не больше 1-2 примечаний на экранную страницу, иначе они перестают привлекать внимание и замусоривают текст.
✅ Не злоупотреблять «красными» примечаниями, помещать в них только действительно критичную информацию. Остальное пишем или просто в тексте, или используем более нейтральные виды примечаний.
✅ Не добавлять слова вроде «ВНИМАНИЕ!» или «Очень важно!!!». А также не использовать капслок, цветные шрифты и восклицательные знаки. Само выделение уже достаточно привлекает внимание.
В комментах покажем, как мы отредактировали пестрящую красным страничку, чтобы примечания стали выполнять свою функцию.
А вы используете примечания в документации? Расскажите о вашей практике!
#давайте_практику
Примечания — классный элемент верстки, ведь он позволяет выделить нужный кусочек текста, чтобы читатель точно его заметил. Но что происходит, когда примечаний слишком много, как на странице в посте? Эффект обратный. Наш мозг невольно их воспринимает как фон, а читать хочется, наоборот, небольшой фрагмент текста, который написан без сложного форматирования.
Вот что важно соблюдать, чтобы примечания работали:
✅ Не больше 1-2 примечаний на экранную страницу, иначе они перестают привлекать внимание и замусоривают текст.
✅ Не злоупотреблять «красными» примечаниями, помещать в них только действительно критичную информацию. Остальное пишем или просто в тексте, или используем более нейтральные виды примечаний.
✅ Не добавлять слова вроде «ВНИМАНИЕ!» или «Очень важно!!!». А также не использовать капслок, цветные шрифты и восклицательные знаки. Само выделение уже достаточно привлекает внимание.
В комментах покажем, как мы отредактировали пестрящую красным страничку, чтобы примечания стали выполнять свою функцию.
А вы используете примечания в документации? Расскажите о вашей практике!
#давайте_практику
👍6✍3❤1🤝1