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

Заглядывайте в закреплённые сообщения :-)
Download Telegram
Все ещё считаете, что наша профессия — для интровертов? ;-)

#давайте_мем
😁22💯7👍5👎1
Инструкция или FAQ?

Надо ли создавать раздел вопросов и ответов, если уже есть пользовательские инструкции? А наоборот? Если есть FAQ, может инструкции не нужны?

Мы думаем, идеально иметь и то, и другое. И связать их между собой.

Инструкция нужна, чтобы детально изучить сценарий какого-то действия в продукте. FAQ позволяет получить ответы на конкретные вопросы и в идеале длинных пошаговых инструкций содержать не должен.

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

Давайте на примере.
Вопрос из FAQ интернет-магазина: «Можно ли отменить уже оплаченный заказ?». В ответе мы должны только рассказать о том, что такая возможность, допустим, существует, и кратко описать, на каких условиях это происходит. Давать пошаговую инструкцию о том, как именно это сделать, в какие разделы идти и на какие кнопки нажимать, тут не нужно. Пользователь только спросил о возможности, он может быть еще на этапе решения о том, делать ли заказ («Если можно отменить, если что, закажу»). Но после прямого ответа на вопрос мы можем дать ссылку на раздел руководства, где дается пошаговая инструкция по отмене.

#давайте_практику
👍7🔥71
А если я не хочу жаловаться? 😕😄

#давайте_фейл
😁16👍4👏2
Вызывайте техписа! А когда пора?

Мы уверены, что лучшее время — когда сервис еще в процессе разработки (а вовсе не за два дня до релиза, как часто бывает).

✔️ Если нужны тексты для интерфейсов (названия кнопок, разделов, подсказки), лучше подключаться к проекту на самых ранних этапах, когда готовы бизнес-требования и началась разработка макетов.

✔️ Если нужны только инструкции, оптимально начинать работу, когда уже утверждены макеты, а еще лучше когда готов тестовый стенд. Если начать до этого момента, есть риск, что инструкции придется переписывать несколько раз вслед за изменениями в интерфейсах.
___
Это идеальный вариант. В реальной практике техписы подключаются к задачам на самых разных этапах. И, конечно, лучше поздно, чем никогда.

А вы что думаете? Бывает ли слишком поздно? А слишком рано?

#давайте_про_процессы
👍12🤝31
Это просто праздник какой-то! Один митап за другим. Только недавно слушали крутых спикеров в доме Cloud, как появилось приглашение на митап в Ozon.
Регистрируйтесь скорее 😉

#давайте_анонс
👏10🔥5👍4
Давайте знакомиться!

Мы о вас уже немного знаем по нашим опросам, а вот вы о нас ничего. Поэтому сегодня мы решили исправить эту несправедливость 😉

В карточках открыли тайну, кто мы, и ответили на вопросы.
С радостью почитаем и ваши ответы на них в комментариях!

UPD Канал начинали делать четверо авторов, но сейчас нас пятеро: Женя Береснева, Настя Московкина, Катя Горбунова, Саша Лютикова и Катя Касаткина. Мы часто общаемся от своего имени в комментариях к постам :-)

____________________________
Ждем и ваших ответов:

1. Расскажи немного о себе.
2. Читаешь ли ты сам инструкции?
3. Какая пословица или цитата помогает в работе?
4. Какая у тебя профдеформация (которая возможно бесит окружающих)?
5. Какая оценка у тебя в аттестате по русскому языку?
6. Что бы ты хотел переписать?
7. Как объясняешь знакомым, кем работаешь?
36🤝11🔥4🙏2
Удивительный мир заказчиков: заказчик сомневающийся

Продолжаем рубрику #давайте_про_заказчиков. Сегодня поговорим о сомневающихся заказчиках. Они часто не могут объяснить, что хотят или что им не нравится в тексте. Сталкивались с такими? Мы — очень часто. Поэтому точно знаем, что надо делать в такой ситуации:

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

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

Задавайте вопрос: «Правильно ли я понял, что…». Так вы избежите риска написать совсем не то, что от вас хотят.

Общайтесь лично. Сразу сможете почувствовать нотки сомнения и неуверенности в голосе заказчика и переспросить.

Предлагайте несколько вариантов формулировок на выбор. Так вашему сомневающемуся заказчику будет гораздо легче принимать решение по тексту.

Чего делать нельзя?
С одной стороны, идти на поводу всех сомнений. А с другой — игнорировать какие-то важные моменты. Иногда заказчик не может сформулировать, что ему не нравится, но это вполне может говорить, что в тексте надо что-то изменить. Поможет такой прием — отложите текст на день, а потом свежим взглядом пройдитесь по нему от начала до конца. Уверены, озарение не заставит себя долго ждать.

А что делаете вы с сомневающимися заказчиками?

#давайте_про_заказчиков
#давайте_лайфхак
7👍7🔥4
Рассказать подробнее про технологию единого источника?
Anonymous Poll
95%
Да, интересно!
5%
Да нет, не надо
Кто последний? На вычитку 

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

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

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

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

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

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

#давайте_про_процессы
👍10🔥5🤝4