Всё для технического документирования
+7 (925) 328-76-00
Разработка технической документации
Курсы для технических писателей
Программное обеспечение

Новости о техническом писательстве

Адвокат пользователя. Осторожнее со словами

05.05.2016

05.05.16Нил Каплан, автор серии «Адвокат пользователя», отличается от многих технических писателей тем, что пишет не для компании, не для того, чтобы просто что-то написать, а для своего пользователя. Клиентоориентированность сегодня стоит во главе угла любого бизнеса, поэтому предлагаем ознакомиться – а в идеале и перенять – некоторые из принципов такого подхода.


Я хотел бы поговорить о словах, которыми мы пользуемся. Мы технические коммуникаторы, и наш основной инструмент общения с аудиторией – слова. Создаём ли мы руководство пользователя, онлайн-справку, всплывающие подсказки или надписи в интерфейсе. Даже обучающее видео – это комбинация картинок и слов. Читать дальше…



Насколько глобален ваш английский: 8 способов писать просто и много экономить

03.03.2016

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


Какого *&^! это значит? Мы все хоть раз говорили так. Ладно, мы все хоть раз говорили что-то вроде этого. Фактически вы можете не знать, что означает *&^!. Это не однозначно. Даже если я сама не знаю, какое слово должно быть здесь, как же переводчик узнал бы, что с этим делать?

Зачем делать работу вашего переводчика сложнее – и дороже – чем она должна быть? Почему бы не исключить двусмысленности сразу же? Читать дальше…



Как улучшить написание записей для блога и технических статей

19.11.2015

00Диа Ривз, редактор из Microsoft, делится своими советами с писателями, которые ведут технические блоги и пишут публикации для технических изданий. Советы основаны на её восприятии современных тенденций в ИТ-области, и они будут полезны широкому кругу документаторов.


Привет всем, кто потерял команду по разработке контента (или никогда не имел) и обнаружил, что теперь вы писатель! Ушли те дни, когда менеджеры по проектам писали спецификации, разработчики писали код, технические писатели документировали то, как использовать функциональность, а редакторы собирали всё это в кучу.

Давайте послушаем… группа вздыхает…

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



Как структурировать объёмный текст

16.09.2015

Часто говорят о том, что нужно писать как можно короче, убирать лишнее, что никто не читает большие тексты и т.д. и т.п. Но как быть, если ваша история не помещается в тесные рамки минимализма? В статье несколько советов о том, как написать объёмный пост или какой-либо другой текст так, чтобы он не вызывал реакцию «слишком-многобукв-не-буду-читать». Автор текста: Скотт Несбитт (Scott Nesbitt).


Толпа адептов TLDR (too long, didn’t read; слишком длинно, не читал) сейчас удивится, но… в Интернете есть место для текстов крупных форм. И в печати тоже.

Я не буду подробно рассказывать, почему крупные формы важны — это тема другого поста в другое время. Если у вас есть интересная история, то нет причин, по которым вы не можете занять немного больше времени, немного больше места и чуть больше слов, чтобы рассказать её. Читать дальше…



Как отличить технического писателя от автора маркетинговых текстов

27.08.2015

В последнюю неделю лета мы решили слегка разбавить «умные» узкоспециализированные публикации нашего блога шуточной статьёй об отличиях писателей – технического и маркетингового.

Технические коммуникации VS Маркетинговые коммуникации. Рисунок за авторством Antonio Prohias был впервые опубликован в январе 1961 года в журнале Mad Magazine (#60)

Технические коммуникации VS Маркетинговые коммуникации. Рисунок за авторством Antonio Prohias был впервые опубликован в январе 1961 года в журнале Mad Magazine (#60)

Возможно, автор этой сравнительной таблицы, технический писатель Иегошуа Пол (Yehoshua Paul), чуть сгустил краски, но зато с её помощью непосвящённым будет проще понять, чем же занимаются представители этих таких похожих названиями, но таких разных профессий.

Хотите серьёзно заниматься техническими текстами? Тогда вам просто необходимо пройти курс для настоящих технических писателей!


Для внешнего мира, для тех, кто «не в вашей песочнице», может быть сложно с первого взгляда отличить типичного технического писателя от типичного маркетингового писателя (то есть, автора маркетинговых текстов). А для того, кто живёт одной из этих профессий, разница очевидна. Если вам, вашим коллегам или друзьям трудно отличить их, воспользуйтесь простым списком, приведённым ниже, чтобы знать, какой бейджик бы подошёл человеку – технический писатель или маркетинговый. Это может помочь вам избежать часов, проведённых в состоянии фрустрации, и не задеть чувства обеих сторон… Читать дальше…



Лаконичность без примитивизма

20.07.2015

минимализмРанее мы уже публиковали статью на тему УТР – упрощённого технического русского языка, присланную одним из читателей нашего блога. Сегодня мы публикуем другую статью на эту же тему, которая затрагивает не только принципы русского языка, но и инструменты, необходимые для внедрения принципов УТР в организации. Тема эта актуальна, и это подтверждается в том числе тем, что автор данной публикации – тоже читатель нашего блога, который делится своим опытом, за что ему большое спасибо!
Автор: Владислав Москалёнок, старший технический переводчик, Bercut Ltd.


Упрощенный технический русский язык

В последнее время усилилась тенденция перехода на упрощенный технический русский язык (УТР), возникшая вслед за Simplified English (SE). Прежде всего, область применения SE и УТР – техническая и эксплуатационная документация на аппаратные и программные средства, бытовую технику и прочее оборудование. Читать дальше…



Словесные премудрости: параллелизм заставит выравнивать по левому краю (часть 2)

15.10.2014

01Мы заканчиваем публикацию занимательной статьи о сложностях красивого письма. Причём эти сложности подстерегают нас вне зависимости от того, на каком языке мы пишем.


А так как этот воображаемый список висит на воображаемой дверце моего холодильника, он выровнен по левому краю.

Почему? Потому что когда пункты состоят из нескольких слов, я хочу сфокусироваться на первом. Потому что параллелизм требует одинакового начала.

Прелесть левого края в том, что вы можете повести пальцем по пунктам. Попробуйте. Проведите пальцем по левому краю этих заголовков. Палец привлечёт внимание к выделенным словам:

Как обновить комплект

Загружаем прошивку

Устанавливаем операционную систему

Подключение к облаку

Аналитика Читать дальше…



Словесные премудрости: Параллелизм заставит выравнивать по левому краю (часть 1)

13.10.2014

13.10.14Представляем вашему вниманию очередную статью Марсии Рифер Джонссон, которая не устаёт делиться с нами маленькими секретами красивого языка и грамотного повествования.


 

Параллелизм. Это слово само по себе – пара рельсов, идеально выравнивающих образы вещей. Ряды кукурузы. Линии напольной плитки. Кольца географической широты. Когда вы говорите или пишете, вы выравниваете слова. Это происходит естественным образом. Вы забегаете в магазин и говорите: «Мне, пожалуйста, фисташки, тунец и шампанское». Вы не думаете «Мне надо выровнять ряд существительных». Существительные сами выравниваются. Слова ищут себе подобных, как сказал Шеридан Бейкер: «…существительное к существительному, прилагательное к прилагательному, инфинитив к инфинитиву» (The Practical Stylist, 1998). Читать дальше…



Словесные премудрости: Слова-связки

22.08.2014

22.08.14Мы часто публикуем советы по каким-то техническим трудностям профессии технического писателя. Но не стоит забывать о том, что технический писатель – он всё-таки не только технарь, но и писатель. То есть о писательских навыках, грамматике и стилистике тоже нужно помнить. Сегодня Марсия Рифер Джонссон поделится с нами размышлениями о важности плавного повествования.

Хотите начать лучше разбираться в стилистике технических текстов, изучить множество других вопросов по теории разработки технических текстов и приобрести практические навыки? Всё это Вы получите, освоив курс «Разработка технических текстов и документации».

Что не так с этим отрывком?

Связки делают поток слов плавным. Связки — это слова или фразы, иногда целые абзацы, которые присоединяют одну идею к другой. Обычно (!) связки ставятся в начале предложения или абзаца. Они могут ставиться в середине или в конце. Они направляют своего читателя, раскрывая логику развития мысли. Чрезмерное использование связок может запутать или отвлечь читателей. Избегайте использования связок в каждом предложении. Абзацы – другое дело. Если вы не пишете прямое повествование – это произошло, то случилось – в большинстве абзацев должны быть связки. Думайте о предложениях и абзацах, как частях тела. Они и есть части тела. Телу нужны суставы. Читать дальше…



Не позволяйте английскому в качестве второго языка стать источником раздражения!

04.06.2014

04.06.14Сейчас большая часть вакансий сопровождается крупной надписью – «Знание английского языка обязательно». Технические писатели не стали исключением. Нередко возникает необходимость создать англоязычный документ либо перевести уже существующий. Зачастую писатель берётся за такую работу, не сомневаясь в своей компетенции – ведь, казалось бы, чего сложного, тему я знаю, термины есть в словаре, да и язык я учил с 6 лет, а однажды даже общался с живым американцем. Мы ни в коем случае не сомневаемся в вашем профессионализме, но хотим предостеречь от частой ошибки – полагаться только на свои знания и не пользоваться услугами редактора.


Те, для кого английский – второй язык, зачастую несправедливо страдают. Это потому что всё, начиная от языкового выражения, заканчивая понятиями, теряет ясность. И это может привести к неправильному впечатлению и неоправданному превосходству над ними носителей языка. Читать дальше…