Задача — сделать стайлгайд. Идеальная структура
Мы привыкли, что идеальная структура документа должна идти от процесса. Но ведь стайлгайд не описывает процесс! Какой же должна быть его структура, из каких разделов он должен состоять?
На самом деле структуру гайда можно привязать к процессу вычитки, ведь на вычитке мы как раз проверяем соответствие документа стайлгайду. Каким мы видим идеальную вычитку — смотрите в докладе Кати Горбуновой на TWD1.
Итак, то, что мы проверяем, и может стать разделами в структуре стайлгайда. Например:
🔹Требования к структуре документа
🔹Требования к структуре страницы
🔹Лексика
🔹Типографика и специальная пунктуация
и т.д. в зависимости от того, что проверяете вы.
Резонный вопрос: а как же БАЗА? Где написать основные постулаты и правила? Если их будет немного — им место на главной странице. Если правил приличное
количество — выделите их в отдельный раздел в самом начале документа.
А какая структура гайда у вас?
#давайте_практику #давайте_про_стайлгайд
Мы привыкли, что идеальная структура документа должна идти от процесса. Но ведь стайлгайд не описывает процесс! Какой же должна быть его структура, из каких разделов он должен состоять?
На самом деле структуру гайда можно привязать к процессу вычитки, ведь на вычитке мы как раз проверяем соответствие документа стайлгайду. Каким мы видим идеальную вычитку — смотрите в докладе Кати Горбуновой на TWD1.
Итак, то, что мы проверяем, и может стать разделами в структуре стайлгайда. Например:
🔹Требования к структуре документа
🔹Требования к структуре страницы
🔹Лексика
🔹Типографика и специальная пунктуация
и т.д. в зависимости от того, что проверяете вы.
Резонный вопрос: а как же БАЗА? Где написать основные постулаты и правила? Если их будет немного — им место на главной странице. Если правил приличное
количество — выделите их в отдельный раздел в самом начале документа.
А какая структура гайда у вас?
#давайте_практику #давайте_про_стайлгайд
👍12❤5✍2⚡1
Давайте розыгрыш!
Ровно через месяц, 25 августа, нас ждет классное мероприятие — WriteConf. Вместе соберутся все, кто работает с текстами — технические писатели, UX-редакторы, контент-маркетологи и многие другие.
Большая часть программы уже на сайте. Кстати, один из авторов нашего канала выступает с провокационной темой «Прекратите думать об этом: самые популярные и бесполезные споры про текст» 😉
Заинтересовали? Хотите поучаствовать?
Разыгрываем онлайн-билет среди наших подписчиков. А это:
✅ Доступ к онлайн-трансляции
✅ 3 потока лекций по Write
✅ Записи всех докладов
Как выиграть билет
1. Подписаться на канал конференции и наш канал, если еще не подписаны.
2. Написать любой комментарий под этим постом.
3. Дождаться розыгрыша 1 августа — каждому комментарию от одного пользователя присвоим порядковый номер, а потом запустим генератор случайных чисел.
Поехали!
Ровно через месяц, 25 августа, нас ждет классное мероприятие — WriteConf. Вместе соберутся все, кто работает с текстами — технические писатели, UX-редакторы, контент-маркетологи и многие другие.
Большая часть программы уже на сайте. Кстати, один из авторов нашего канала выступает с провокационной темой «Прекратите думать об этом: самые популярные и бесполезные споры про текст» 😉
Заинтересовали? Хотите поучаствовать?
Разыгрываем онлайн-билет среди наших подписчиков. А это:
✅ Доступ к онлайн-трансляции
✅ 3 потока лекций по Write
✅ Записи всех докладов
Как выиграть билет
1. Подписаться на канал конференции и наш канал, если еще не подписаны.
2. Написать любой комментарий под этим постом.
3. Дождаться розыгрыша 1 августа — каждому комментарию от одного пользователя присвоим порядковый номер, а потом запустим генератор случайных чисел.
Поехали!
🔥30👍7👏2
Дефисы, запятые и другие монстры: как укротить орфографию
Работа технического писателя — это не только умение лаконично и понятно передавать сложную информацию. Хороший техпис умеет писать так, что читателю не приходится постоянно задумываться, сколько уроков русского языка автор прогулял в школе.
Грамотность — это наша визитная карточка, а еще уважение к читателю. Ошибки в тексте могут испортить впечатление от любой инструкции, а ее смысл будет утерян в дебрях грамматических ловушек.
Так что проверяйте себя и не полагайтесь только на свое чутье. А мы делимся своими методами.
✅ Не ленитесь и перечитывайте то, что вы написали. Чтение вслух или пословно с конца — это вообще суперспособ: сразу заметите, если пропустили что-то важное.
✅ Чтобы избежать грамматических казусов, заглядывайте в словари и справочники русского языка. Справочник Розенталя — это не нудный свод ограничений, а лучший друг и настольная книга технического писателя.
✅ Установите надежный редактор, который подчеркнет каждую запятую, поставленную не туда, и «закричит», если вы нечаянно написали «кноппка». Word, Google Docs, Grammarly — неплохие варианты.
✅ Если у вас есть тот самый коллега, который за обедом поправляет ваше ударение в слове «торты», — это идеальный вычитывающий. Да, иногда раздражает, но зато точно найдет все ошибки в тексте.
✅ Используйте чудесные онлайн-сервисы. Введите текст в «Главред», чтобы убрать лишние стоп-слова. Закиньте текст в любую программу проверки орфографии, чтобы отловить неловкие опечатки.
✅ Оставьте текст «на потом». Да, серьезно. После перерыва шансы обнаружить собственные ошибки гораздо выше.
✅ Если времени на проверку совсем нет, а сомнения по поводу лишних запятых — есть, просто переформулируйте предложение, чтобы избежать сложной пунктуации.
✅ У каждого — свои «любимые» ошибки. Кто-то ставит везде лишний дефис, кто-то обожает длинные предложения без единой запятой. Создайте чек-лист своих «коронных» ошибок и проверяйте свои тексты по этому списку. Кстати, какая у вас? Расскажите в комментариях 😉
В общем, ленитесь в чем угодно, но не в проверке своего текста. Мы все порой совершаем ошибки. Главное — вовремя их найти и обезвредить!
#давайте_лайфхак
Работа технического писателя — это не только умение лаконично и понятно передавать сложную информацию. Хороший техпис умеет писать так, что читателю не приходится постоянно задумываться, сколько уроков русского языка автор прогулял в школе.
Грамотность — это наша визитная карточка, а еще уважение к читателю. Ошибки в тексте могут испортить впечатление от любой инструкции, а ее смысл будет утерян в дебрях грамматических ловушек.
Так что проверяйте себя и не полагайтесь только на свое чутье. А мы делимся своими методами.
✅ Не ленитесь и перечитывайте то, что вы написали. Чтение вслух или пословно с конца — это вообще суперспособ: сразу заметите, если пропустили что-то важное.
✅ Чтобы избежать грамматических казусов, заглядывайте в словари и справочники русского языка. Справочник Розенталя — это не нудный свод ограничений, а лучший друг и настольная книга технического писателя.
✅ Установите надежный редактор, который подчеркнет каждую запятую, поставленную не туда, и «закричит», если вы нечаянно написали «кноппка». Word, Google Docs, Grammarly — неплохие варианты.
✅ Если у вас есть тот самый коллега, который за обедом поправляет ваше ударение в слове «торты», — это идеальный вычитывающий. Да, иногда раздражает, но зато точно найдет все ошибки в тексте.
✅ Используйте чудесные онлайн-сервисы. Введите текст в «Главред», чтобы убрать лишние стоп-слова. Закиньте текст в любую программу проверки орфографии, чтобы отловить неловкие опечатки.
✅ Оставьте текст «на потом». Да, серьезно. После перерыва шансы обнаружить собственные ошибки гораздо выше.
✅ Если времени на проверку совсем нет, а сомнения по поводу лишних запятых — есть, просто переформулируйте предложение, чтобы избежать сложной пунктуации.
✅ У каждого — свои «любимые» ошибки. Кто-то ставит везде лишний дефис, кто-то обожает длинные предложения без единой запятой. Создайте чек-лист своих «коронных» ошибок и проверяйте свои тексты по этому списку. Кстати, какая у вас? Расскажите в комментариях 😉
В общем, ленитесь в чем угодно, но не в проверке своего текста. Мы все порой совершаем ошибки. Главное — вовремя их найти и обезвредить!
#давайте_лайфхак
🔥25❤10✍7💯2
А как вы думаете, техпис должен писать грамотно?
Anonymous Poll
95%
Безусловно, это его работа
5%
Необязательно, главное смысл
👍4
Давайте вакансию!
В Positive Technologies открылся поиск технических писателей! Компания занимается разработкой в сфере кибербезопасности и внедряет подход Docs as code🚀
📌Первая вакансия — для специалистов в конкурсной документации (ГОСТ 2, 19, 34)
📌Вторая вакансия — для тех, кто пишет пользовательские инструкции по внутренним стандартам компании
Самое интересное:
▪️ Погружение в продукт: технические писатели близко к разработке
▪️ Решаем сложные технические задачи и исследуем новое
▪️ Прозрачные условия: IT аккредитация, бронь, 10 дополнительных дней отпуска, удаленка и многое другое
Хочешь присоединиться к команде? Пиши рекрутеру в тг: @ksnstv
#давайте_вакансию
В Positive Technologies открылся поиск технических писателей! Компания занимается разработкой в сфере кибербезопасности и внедряет подход Docs as code🚀
📌Первая вакансия — для специалистов в конкурсной документации (ГОСТ 2, 19, 34)
📌Вторая вакансия — для тех, кто пишет пользовательские инструкции по внутренним стандартам компании
Самое интересное:
▪️ Погружение в продукт: технические писатели близко к разработке
▪️ Решаем сложные технические задачи и исследуем новое
▪️ Прозрачные условия: IT аккредитация, бронь, 10 дополнительных дней отпуска, удаленка и многое другое
Хочешь присоединиться к команде? Пиши рекрутеру в тг: @ksnstv
#давайте_вакансию
🔥17✍4👍3
This media is not supported in your browser
VIEW IN TELEGRAM
Давайте уже итоги розыгрыша!
Что ж, давайте. Мы раздали номера всем участникам и раскрутили виртуальный барабан.
И та-дам! Поздравляем @MariyaTW
К вам в личку скоро придет специальный человек и расскажет, как получить ваш билет на WriteConf! :)
А всем остальным участникам розыгрыша организаторы конференции по нашей просьбе решили дать скидку 10% на онлайн или офлайн-билет. Напишите в комментариях, если вам нужно, и мы отправим вам промокод.
Что ж, давайте. Мы раздали номера всем участникам и раскрутили виртуальный барабан.
И та-дам! Поздравляем @MariyaTW
К вам в личку скоро придет специальный человек и расскажет, как получить ваш билет на WriteConf! :)
А всем остальным участникам розыгрыша организаторы конференции по нашей просьбе решили дать скидку 10% на онлайн или офлайн-билет. Напишите в комментариях, если вам нужно, и мы отправим вам промокод.
🔥11👏4👍3❤1
Техпис и аналитик: где граница
Отвечает ли технический писатель за всю документацию на проекте? Очевидно, нет. Но где тогда граница его ответственности? Пожалуй, больше всего вопросов возникает в точке пересечения обязанностей техписа и аналитика. Допустим, в команде есть системный и/или бизнес-аналитик и технический писатель — за какие артефакты отвечает каждый из них?
Мы считаем, что аналитики разрабатывают документы, которые нужны, чтобы продукт создавать и поэтому подключаются на самых ранних этапах разработки. И это, прежде всего, внутренние документы — для самой команды. Оформить «хотелки» заказчика в бизнес-требования, чтобы разработчики опирались на них, создавая приложение, описать все возможные пользовательские сценарии в User Stories, сформулировать системные требования и так далее. Эти артефакты нужны, чтобы продукт вообще появился на свет.
Задача же технического писателя — делать продукт более понятным тем, кто им пользуется. В этом смысле мы всегда имеем дело с уже созданным сервисом и подключаемся к работе на поздних этапах. И наши артефакты почти всегда внешние. Для конечных пользователей мы пишем инструкции и руководства, release notes и даже рассылки, чтобы рассказать обо всех возможностях сервиса. Для поддержки мы создаем описания сервиса, рассказываем о типичных проблемах и способах их решения. Другим командам разработки, которые хотят интегрироваться с нашим сервисом, рассказываем, как работает API.
Таким образом, хочешь узнать, кто должен разрабатывать тот или иной артефакт, — спроси себя, для чего он нужен. Поможет создать продукт — это к аналитику. Поможет сделать готовый продукт понятнее — это к техпису.
Что думаете про такой критерий разделения? Давайте обсудим.
P.S. Речь про границы профессий, а не конкретные рабочие позиции. Если в вашей трудовой написано «технический писатель», но вы пишете не только инструкции, но и бизнес-требования, это лишь означает, что на этом конкретном рабочем месте вы еще и аналитик по совместительству.
#давайте_про_профессию
Отвечает ли технический писатель за всю документацию на проекте? Очевидно, нет. Но где тогда граница его ответственности? Пожалуй, больше всего вопросов возникает в точке пересечения обязанностей техписа и аналитика. Допустим, в команде есть системный и/или бизнес-аналитик и технический писатель — за какие артефакты отвечает каждый из них?
Мы считаем, что аналитики разрабатывают документы, которые нужны, чтобы продукт создавать и поэтому подключаются на самых ранних этапах разработки. И это, прежде всего, внутренние документы — для самой команды. Оформить «хотелки» заказчика в бизнес-требования, чтобы разработчики опирались на них, создавая приложение, описать все возможные пользовательские сценарии в User Stories, сформулировать системные требования и так далее. Эти артефакты нужны, чтобы продукт вообще появился на свет.
Задача же технического писателя — делать продукт более понятным тем, кто им пользуется. В этом смысле мы всегда имеем дело с уже созданным сервисом и подключаемся к работе на поздних этапах. И наши артефакты почти всегда внешние. Для конечных пользователей мы пишем инструкции и руководства, release notes и даже рассылки, чтобы рассказать обо всех возможностях сервиса. Для поддержки мы создаем описания сервиса, рассказываем о типичных проблемах и способах их решения. Другим командам разработки, которые хотят интегрироваться с нашим сервисом, рассказываем, как работает API.
Таким образом, хочешь узнать, кто должен разрабатывать тот или иной артефакт, — спроси себя, для чего он нужен. Поможет создать продукт — это к аналитику. Поможет сделать готовый продукт понятнее — это к техпису.
Что думаете про такой критерий разделения? Давайте обсудим.
P.S. Речь про границы профессий, а не конкретные рабочие позиции. Если в вашей трудовой написано «технический писатель», но вы пишете не только инструкции, но и бизнес-требования, это лишь означает, что на этом конкретном рабочем месте вы еще и аналитик по совместительству.
#давайте_про_профессию
👍30❤9💯3🤝3
Вечное обслуживание. Ну, почти — до 17.08.
Порядок слов в текстах не важен, говорите? 😉
Давайте перепишем?
#давайте_фейл
Порядок слов в текстах не важен, говорите? 😉
Давайте перепишем?
#давайте_фейл
😁36🔥5🏆3🌚1
Last call
Осталось совсем мало времени, чтобы успеть подать доклад на третью конференцию Techwriter Days!
В прошлых двух мы принимали участие и в третьей тоже обязательно будем.
Очень ждем новых встреч и, конечно, интересных докладов!
Расскажите о своем опыте использования ИИ, о подходе к редактуре, про автоматизацию или локализацию — нераскрытых тем бесконечно много. Среди них точно есть та, в которой вы эксперт.
Подавайтесь, даже если пока есть только идея, без деталей. Докрутить тему, подготовиться к выступлению и настроиться на него помогут опытные кураторы. Так что не сомневайтесь, подавайте доклады и давайте делиться опытом!
#давайте_анонс
Осталось совсем мало времени, чтобы успеть подать доклад на третью конференцию Techwriter Days!
В прошлых двух мы принимали участие и в третьей тоже обязательно будем.
Очень ждем новых встреч и, конечно, интересных докладов!
Расскажите о своем опыте использования ИИ, о подходе к редактуре, про автоматизацию или локализацию — нераскрытых тем бесконечно много. Среди них точно есть та, в которой вы эксперт.
Подавайтесь, даже если пока есть только идея, без деталей. Докрутить тему, подготовиться к выступлению и настроиться на него помогут опытные кураторы. Так что не сомневайтесь, подавайте доклады и давайте делиться опытом!
#давайте_анонс
🔥11👍3✍2
Проверка грамотности: как не надо
Недавно мы делились нашими способами проверять текст на ошибки. А сегодня вредные советы: чего делать не стоит, если хотите, чтобы ваш текст был грамотным.
❌ Верить своему чутью. Даже у самых грамотных специалистов оно иногда подводит.
❌ Ссылаться на «авторскую пунктуацию». Ее могут себе позволить поэты и писатели, но никак не технические.
❌ Гуглить и смотреть, как у других. Бывает, что на сайтах во всех первых строках поисковой выдачи слово написано неверно, а в текстах авторитетной компании слово написано не так, как в словарях.
❌ Опираться на ответы филологов на Gramota.ru как на единственный источник. Бывает, что ответ старый и норма успела измениться, особенно это касается заимствованных слов, которые регулярно добавляют в словари.
#давайте_лайфхак
Недавно мы делились нашими способами проверять текст на ошибки. А сегодня вредные советы: чего делать не стоит, если хотите, чтобы ваш текст был грамотным.
#давайте_лайфхак
Please open Telegram to view this post
VIEW IN TELEGRAM
🔥12👍7✍4
Задача — сделать стайлгайд. Наполняем разделы.
Вот мы и перешли, наверно, к самому трудозатратному этапу создания гайда.
Мы бы предложили такой план наполнения страниц:
1️⃣ Накидайте тезисно, какие кейсы нужно включить в гайд. Например, в разделе про пунктуацию это могут быть кейсы про знаки в списках, запрет восклицательных и вопросительных знаков, знаки препинания в заголовках и т.п.
2️⃣ Распишите каждый кейс подробно. По возможности расскажите, как писать хорошо и почему так. Например: «Мы не используем вопросительные и восклицательные знаки, так как в документации мы рассказываем, а не спрашиваем, и уж тем более не кричим».
3️⃣ Придумайте примеры и антипримеры. Ничего не работает так хорошо, как наглядность. Но не стоит с ними перебарщивать, в некоторых разделах они могут быть лишними, если все очевидно из пояснения.
4️⃣ Оформите страницы гайда в едином стиле. Примеры оформления можно подсмотреть в публичных гайдах.
5️⃣ Добавьте страницу, в которой опишите ваш подход к текстам и общие принципы — в каком стиле вы пишете, по каким критериям считаете текст качественным.
И даже не надейтесь, что на этом всё ;-) Вы будете постоянно дополнять ваш гайд по следам реальных кейсов, которые будет обсуждать ваша команда
#давайте_про_стайлгайд
Вот мы и перешли, наверно, к самому трудозатратному этапу создания гайда.
Мы бы предложили такой план наполнения страниц:
И даже не надейтесь, что на этом всё ;-) Вы будете постоянно дополнять ваш гайд по следам реальных кейсов, которые будет обсуждать ваша команда
#давайте_про_стайлгайд
Please open Telegram to view this post
VIEW IN TELEGRAM
👍8✍7🔥5
Media is too big
VIEW IN TELEGRAM
Пишем е или ë, кешбэк или кэшбэк? Ставим ли точки в таблицах? Аппрувим или подтверждаем?
Как избежать пустых споров и быстро принять решение в спорных случаях, рассказала Женя Береснева, один из авторов нашего канала, на конференции WriteConf. С удовольствием делимся с вами записью.
Давайте обсудим!
Как избежать пустых споров и быстро принять решение в спорных случаях, рассказала Женя Береснева, один из авторов нашего канала, на конференции WriteConf. С удовольствием делимся с вами записью.
Давайте обсудим!
🔥39❤13👍9👏2
This media is not supported in your browser
VIEW IN TELEGRAM
А у нас день рождения!
Сегодня исполняется год нашему каналу 🎉
Главные цифры на картинке, а вот еще немного статистики:
— Больше всего репостов собрал чек-лист оформления инструкции
— Вот этот мемчик собрал больше всего лайков
— А пост про зону ответственности техписа оказался самым обсуждаемым
Кстати, лучший подарок для любого канала — новые читатели. Репостните любой наш пост в ваш рабочий чатик или просто расскажите про нас коллегам, мы будем очень рады 😊
Поздравления в комментариях тоже принимаем 🥳
Сегодня исполняется год нашему каналу 🎉
Главные цифры на картинке, а вот еще немного статистики:
— Больше всего репостов собрал чек-лист оформления инструкции
— Вот этот мемчик собрал больше всего лайков
— А пост про зону ответственности техписа оказался самым обсуждаемым
Кстати, лучший подарок для любого канала — новые читатели. Репостните любой наш пост в ваш рабочий чатик или просто расскажите про нас коллегам, мы будем очень рады 😊
Поздравления в комментариях тоже принимаем 🥳
🎉40🍾11🔥7❤🔥4❤1
Карьерные вопросы. Почему не нужно грустить из-за отказа
Каждый из нас хотя бы раз искал работу. А учитывая новые тенденции, некоторые ищут работу в среднем раз в год. И, конечно же, хотя бы раз все мы получали отказ.
Отказ можно получить на любом из этапов: HR-скрининг, тестовое задание, техническое собеседование или собеседование с командой. Когда читаешь “к сожалению, мы не готовы предложить вам…”, особенно первое время, кажется, что “я плохой”, “я недостаточно хорош для компании”, даже если собеседование прошло хорошо и казалось, что офер в кармане.
В редакции нашего канала есть нанимающие менеджеры, можем с уверенностью сказать, что часто поток соискателей очень большой, и нам важно выбрать наиболее подходящего кандидата. В нашей практике были ситуации, что приходит несколько идеальных кандидатов, и менеджер стоит перед сложным выбором — выбрать лучшего из лучших. А это очень сложно.
Так что не расстраивайтесь, когда получили отказ, а попробуйте еще раз через какое-то время, тем более к следующей попытке скиллы ваши вырастут.
Каждый из нас хотя бы раз искал работу. А учитывая новые тенденции, некоторые ищут работу в среднем раз в год. И, конечно же, хотя бы раз все мы получали отказ.
Отказ можно получить на любом из этапов: HR-скрининг, тестовое задание, техническое собеседование или собеседование с командой. Когда читаешь “к сожалению, мы не готовы предложить вам…”, особенно первое время, кажется, что “я плохой”, “я недостаточно хорош для компании”, даже если собеседование прошло хорошо и казалось, что офер в кармане.
В редакции нашего канала есть нанимающие менеджеры, можем с уверенностью сказать, что часто поток соискателей очень большой, и нам важно выбрать наиболее подходящего кандидата. В нашей практике были ситуации, что приходит несколько идеальных кандидатов, и менеджер стоит перед сложным выбором — выбрать лучшего из лучших. А это очень сложно.
Так что не расстраивайтесь, когда получили отказ, а попробуйте еще раз через какое-то время, тем более к следующей попытке скиллы ваши вырастут.
❤29🔥6👍4