Давайте перепишем! – Telegram
Давайте перепишем!
810 subscribers
62 photos
3 videos
32 links
Пиши как техпис.
Рассказываем о буднях технических писателей, наших лайфхаках, болях и инсайтах.

Заглядывайте в закреплённые сообщения :-)
Download Telegram
Кто последний? На вычитку 

У нас в команде вычитка (проверка) готового документа состоит из нескольких этапов:

Саморевью;
Вычитка коллегой-техписом;
Проверка заказчиком. 

Но кто после кого должен вычитывать? Сначала, конечно, сам себя, но кто потом? Сначала заказчик или сначала коллега?

Мы попробовали два варианта, и у каждого есть свои плюсы и минусы (написали о них на карточках).

В итоге пришли к выводу, что вычитка документа — «внутренняя кухня» технического писателя. Заказчик должен получать уже готовый документ, а технический писатель — вникать в продукт и проверять документ со всех сторон, даже если он просто вычитывающий коллега. 

А вы сторонники какого варианта?

#давайте_про_процессы
👍10🔥5🤝4
Какой вариант поздравления с праздником написан без ошибки?
Anonymous Quiz
20%
С Новым Годом!
71%
С Новым годом!
7%
С новым годом
1%
С новым Годом
🙉7👍51
Совсем-совсем скоро эта милая капибара-техпис захлопнет крышку своего ноутбука и не откроет ее целых 11 дней 🥶🎉

Все это время она будет гулять по красивым местам, пить вкусный чай, смотреть интересное кино, общаться с любимыми... В общем, заниматься тем, что приносит новогоднюю радость
🎄🎅🎊

Желаем всем нашим подписчикам того же и до встречи в 2025-м!
🍾29🎄14🎅2
Начнём 2025-й с полезного.

Дело в том, что в июле прошлого года у нас ещё не было канала, поэтому мы вам не рассказали, что совместно с дизайнерами сделали ToV и гайд для текстов в интерфейсе.

А о том, как и почему мы сделали этот гайд, рассказали в статье на Хабр.

Кстати, стайлгайд для технических писателей у нас тоже есть, но пока внутренний. Скоро покажем подборку гайдов других компаний, в которые мы заглядываем ☺️

#давайте_про_стайлгайд
🔥2464🎉3
Боязнь чистого листа

Фобия, с которой чаще остальных сталкиваются начинающие технические писатели. С чего начать написание инструкции? Как бы начать так, чтобы потом не переписывать?

У нас есть два небольших совета:

Начните с записи тезисов по задаче прямо на встрече с заказчиком. Да, текст первоначально будет выглядеть сумбурным и несвязным, но потом, вернувшись на рабочее место и перечитав все, что накидали, вам будет уже сильно проще превратить это в складное описание.

Накидайте структуру страницы. Это можно сделать ещё до встречи с заказчиком, если есть понимание примерного контекста задачи. Примерная структура поможет вам, кстати, лучше продумать вопросы к заказчику, чтобы снизить вероятность повторной встречи. Особенно если ваш заказчик неуловимый.

Ну а что делать с боязнью переписывать? Тут просто принять тот факт, что переписывать или вносить правки всё равно придётся. И, скорее всего, не один раз😉

А у вас бывает страх чистого листа? Как справляетесь?

#давайте_лайфхак
👍11🔥42
Мы очень ждем главного события года — конференции TechWriter Days, которая пройдет 27-28 марта в Санкт-Петербурге.

И вот, программа конференции, наконец, сформирована! 🎉 Просто пробегитесь по заголовкам докладов, это праздник какой-то 😉

В два дня конференции уместились больше 60 докладов и мастер-классов 😱
И наш главный вопрос — как разорваться между сразу 4 секциями, в каждой из которых интересный доклад 🥲😁

Какие доклады больше всего ждете? Какие названия вас больше всего заинтриговали?

_______
Несколько полезных ссылок:
Билеты
Скидки
Канал и чат конференции
🔥6👍2🍾1
Не, ну так-то все понятно 😄

Уведомление в одном из популярных приложений, где, видимо, решили, что UX-райтер не нужен...

#давайте_фейл
😁14🤯7👍2💯1
Пиши сокращай проверяй

Сегодня хотим поделиться лайфхаками, чтобы вычитка прошла просто и качественно. Мы пользуемся этими приемами и при вычитке своего документа, и когда вычитываем коллегу.

✏️ Вычитывайте вслух. Незаметные глазу шероховатости очень хорошо слышно. Если спотыкаетесь — это верный признак, что лучше упростить предложение.

✏️ Когда вычитываете, представляйте себя в разных ролях: новичок, продвинутый пользователь, редактор.

✏️ Сделайте паузы перед итерациями вычитки, хотя бы 30 минут. И в следующий подход документ будет восприниматься свежим взглядом. Не зря говорят: «утро вечера мудренее».

✏️ Обманите мозг. Прочитайте статью с конца. Так легче заметить ошибки — ум идет не по проторенной дорожке. Конечно, этот вариант не подойдет, когда вы проверяете структуру документа, но вот найти канцеляриты или орфографические ошибки точно можно.

✏️ И наконец, прислушивайтесь к своему внутреннему голосу. Если вам кажется, что что-то не так — вам не кажется. Попробуйте переписать или перефразировать ваше предложение.

Дополняйте наш список и делитесь своими советами в комментариях.

#давайте_лайфхак
12💯84🔥2
Нам кажется, что большинство техписов сейчас работают на удалёнке. Проверим?
А в комментах расскажите, нравится ли вам ваш вариант :)
Anonymous Poll
56%
Я на удаленке
25%
На удаленке, но иногда бываю в офисе
19%
Я в офисе
🔥3🥴1
Заказчик-перфекционист: когда правок не счесть

Сегодня в рубрике #давайте_про_заказчиков новый герой — заказчик-перфекционист.

Он стремится к совершенству, поэтому без остановки критикует ваш текст, а согласование растягивается на огромное количество итераций. Знакомо?

Если вы, как и мы, не любите править поправленное до бесконечности, берите наши лайфхаки на заметку:

Согласовывайте с таким заказчиком текст не полностью, а частями.
Перед отправкой на согласование заказчику попросите посмотреть текст нескольких экспертов по вопросу и других технических писателей.
Обязательно отстаивайте свою точку зрения и объясняйте заказчику, почему так и почему так лучше.
Обговаривайте дедлайны и максимальное количество вычиток, чтобы вы могли выполнить задачу в срок.
Договоритесь, какие основные правки вы вносите до определенной даты, менее важные — переносите в отдельную задачу на доработку.
Добавьте в конец инструкции чек-бокс «Согласовано». Когда заказчик поставит в нем галочку, технически закрывайте возможность внесения правок.

Заказчик, возможно, так не думает, но на самом деле добиться идеального текста невозможно. Поэтому лучше сосредоточьтесь на главном — помощи пользователям. Всевозможные улучшательства текста — задача не первого приоритета. В первую очередь, исправляйте то, что действительно может вызывать проблемы у пользователей, а не у вашего заказчика-привереды.

#давайте_про_заказчиков
#давайте_лайфхак
7👍4🔥3
😁15💯15🤡12🔥2🤨2👎1👏1
Если есть профессия, есть и ее день :-)
Технические писатели пока не определились, когда праздновать.

Но есть две версии, которые нам нравятся:
🔸 1 февраля — потому что кнопка F1 (February, 1) обычно вызывает Справку в приложении.
🔸 2 февраля — потому что это 33-й день года, а в русском алфавите 33 буквы (актуально для тех, кто пишет на русском)

Но в любом случае это либо сегодня, либо вчера. Так что поздравим друг друга! :-)

#давайте_про_профессию
🎉24👍3🔥31