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

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

Продающие тексты: 9 формул, приносящих успех

08.12.2017

Сегодняшняя статья — копирайтерам на заметку. Проверенные и простые формулы копирайтинга помогут вам построить структуру продающей статьи. Если вы уже используете некоторые из них – попробуйте другие, это внесёт разнообразие в тексты и, возможно, поможет улучшить результаты.

Если Вы не копирайтер, а владелец бизнеса и Вам нужны качественные статьи для продвижения сайта — не мучайтесь, изучая все эти способы написания текстов, обратитесь к нам! Наши копирайтеры с удовольствием сделают всё за Вас.

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

Ниже вы найдёте 9 основных формул копирайтинга, которые должен иметь в своём арсенале каждый профессиональный копирайтер.

1. Метод четырёх U

Хотя преподаватели по копирайтингу в American Writers and Artists учат этому методу для написания заголовков, он подходит так же хорошо и для любых текстов. По сути метод четырёх U говорит о том, что ваш контент должен: Читать дальше…



Инструкция по улучшению удобочитаемости контента с помощью инструмента анализа текстов в MadCap Flare

01.12.2017

Данная публикация посвящена алгоритму использования инструмента анализа текста в MadCap Flare. Пользователям же других продуктов для документирования будет полезно узнать о методах улучшения удобочитаемости технических текстов, которые можно применять при использовании любого программного обеспечения.


В MadCap Flare 2017 r3 появилась новая функция, которая позволяет оценить ваш проект Flare на удобство чтения, узнать среднюю длину предложения и другие параметры.

Чтобы запустить анализ текста, откройте файл с контентом (например, топик или сниппет). Выберите ленту Tools. В разделе Proofing выберите Text Analysis. Откроется панель с анализом текста. Читать дальше…



Минимизируем документацию

17.11.2017

О том, как минимизировать количество документации и почему это важно, рассказывает Том Джонсон. И хоть эта статья довольно старая (ей 8 лет), тренды, которые наметились в то время, подтвердились и актуальны по сей день. А значит, применимы и советы, данные в этом материале.


На одной из конференций по дизайну интерфейса докладчик Грант Скоусен показал такой рисунок:

 

Простота и сложность Читать дальше…



Читкоды для технических писателей

10.11.2017

Мы решили создать инструкцию к.. карьере технического писателя. Она будет полезна тем, кто:

  • не знает, с чего начать
  • хочет карьерного роста
  • работает давно и хочет разнообразия
  • хочет начать работать удалённо
  • хочет начать зарабатывать больше
  • подумывает сменить работу, но не знает, почему и как
  • не знает, чего хочет
  • любит GTA.

Давайте посмотрим на работу как на игру?

Ты выполняешь квесты, получаешь награду, чувствуешь себя героем, когда всё получается. Но иногда игра заходит в тупик – за тобой гонится полиция, денег на новое оружие, да даже на патроны, нет, до конца выполнения квеста ещё ой как далеко… Ты держишься, пытаешься выбраться из ситуации молодцом, и иногда это даже получается. Но не всегда хватает терпения и порой хочется выключить всё и забросить любимую игрушку подальше. Сил уже нет бороться с этими копами и вечной нехваткой баксов. И вот тут некоторые из нас используют читкоды, вместо того, чтобы сдаться. LEAVEMEALONE – и за тобой уже никто не гонится. PROFESSIONALTOOLS – и ты уже вооружён, как целый элитный боевой отряд. HESOYAM – и ты здоров и богат.

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

(Если вы далеки от игровой терминологии, мысленно замените слово «читы» на «лайфхаки», а заголовок статьи на «Инструкция к карьере технического писателя» 🙂 ) Читать дальше…



Представляем MadCap Flare 2017 r3 и новый релиз MadCap Central

08.11.2017

В данной публикации перечислены новые функции и другие изменения, доступные в новых версиях продуктов для автоматизации и управления документированием на предприятии MadCap Flare и MadCap Central. Все продукты MadCap Software постоянно доступны для приобретения в нашем магазине.

В течение ноября 2017 г. проходит акция: при покупке постоянной лицензией на MadCap Flare осуществляется поставка комплекта MadPak Professional Suite


MadCap Flare 2017 r3 добавлены новый инспектор стилей, импорт из Microsoft® Excel, анализ текстов и другое

Используя эджайл-цикл разработки, мы можем добавлять улучшения к MadCap Flare и поставлять их пользователям чаще, чем прежде. Каждый новый релиз приносит с собой больше функций, расширенную интеграцию и появление новых функций, улучшающих работу над текстами, управление и публикацию контента. Читать дальше…



Зарплата технических писателей

23.10.2017

Опыт работы техническим писателем и отличный английский – вот что нужно, чтобы хорошо устроиться за границей 🙂 Ну, как один из вариантов, конечно. Давайте подробнее рассмотрим перспективы профессии технического писателя за рубежом, а конкретнее – в США.


Технический писатель в США зарабатывает в среднем 57 549 долларов в год (4 796 долларов в месяц). Для этой работы опыт имеет решающее влияние на заработную плату. Большинство людей меняют работу после 20 и более лет стажа в профессии. Владение программой Adobe FrameMaker даёт возможность получать более высокую зарплату.

Задачи технического писателя

Читать дальше…



Представляем MadCap Doc-To-Help 5: Полностью новая улучшенная интеграция с Microsoft® Word

04.10.2017

С каждым новым релизом MadCap Doc-To-Help мы стремимся улучшать ваши возможности по управлению и публикации документов с методиками и технологическими процессами, сайты с онлайн-помощью и другое, и всё это без необходимости отказа от Microsoft® Word. Мы рады поделиться последним релизом Doc-To-Help, в котором добавляется полностью новая, расширенная интеграция с Microsoft® Word, новое меню в Word для доступа к функциям и ресурсам Doc-To-Help, две новых ленты меню для доступа к функциям, относящимся к проектам и целям, а также несколько новых функций в помощь оптимизации процесса авторинга.

Для всех, кто хочет создавать контент и управлять им в привычном окружении на основе Word — приглашаем ознакомиться с новыми функциями и посмотреть, что внутри: Читать дальше…



Ключ к написанию хорошей документации: тестирование инструкций

25.09.2017

Всем нам попадались инструкции, в которых было или сложно найти то, что нужно, или была куча непонятных терминов, или даже отсутствовали какие-то шаги в последовательности действий. А некоторые из нас и сами писали такие инструкции 😏 Чтобы этого избежать, необходимо проводить тестирование документации как неотъемлемой части разрабатываемых продуктов. Статья посвящена организации тестирования документации на предприятии и проблемам, которые при этом возникают. Автор: Том Джонсон, технический писатель из США.

Нет времени писать и/или тестировать инструкции? Заказать разработку инструкции в компании «ПроТекст» — лучшее решение!

Написание хорошей документации требует от вас создания тестовой среды и тестирования всего, что описано в инструкциях – тестирования именно вами и тестирования на уровне пользователя. Тестирование инструкции может быть трудоёмким и заковыристым процессом, особенно с документацией для разработчиков. Увидеть сделанные пробелы и допущения трудно. Но тестирование инструкций даёт вам доступ к инсайтам, которые сделают вашу документацию намного более точной и полезной.

О тестировании

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

Прохождение каждого шага в документации от своего лица, как технического писателя, крайне важно для создания хорошей документации. Однако чем сложнее структура документа, тем сложнее пройти все шаги. Особенно в случае с документацией для разработчиков, эта задача не тривиальна. Но она является неотъемлемой частью создания и пользовательской документации тоже. Читать дальше…



Элементарно, мой дорогой Ватсон: Редактор как Детектив

23.08.2017

Представляем вашему вниманию статью о работе редактора. Автор: Джефф Харт, сейчас работающий на фрилансе научным редактором, а ранее в таких организациях как IBM, Лесничество Канады и Канадский лесной институт.

Нужен редактор? Их есть у нас! Выполним редакторскую и корректорскую правку Ваших текстов в сжатые сроки.

В классической детективной истории отважный сыщик начинает расследования истинной истории события — в литературе, предположим, об убийстве или воровстве. Но при редактировании мы пытаемся обнаружить истинную историю автора и реконструировать её, насколько это возможно, в единое целое, которое уложено логически и поучительно для читателя. (Мы также в какой-то степени раскрываем преступления против языка). Только понимая цепочку событий, детектив может понять, что привело к преступлению.

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

  • мотив
  • благоприятная возможность
  • средства

Читать дальше…



Представляем MadCap Lingo 10.1: Новые функции и улучшения для управления переводами

17.08.2017

Мы рады представить релиз MadCap Lingo 10.1, инструмента для переводов и локализации от MadCap Software, разработанного для упрощения перевода вашей технической документации.

Будь вы технический писатель, готовящий проекты MadCap Flare к переводу или менеджер, управляющий переводами, MadCap Lingo предлагает вам тесно интегрированный производственный процесс для управления переводами — включая упаковку файлов в переводческие проекты, создание и использование переводческой памяти, представление готовых проектов и другое.

Ниже перечислены самые свежие функции, появившиеся в версии 10.1.

Выбор множества целей в свойствах проектов и новый мастер проектов

При создании нового проекта MadCap Lingo вы можете выбрать фильтрацию файлов на основе одной или множества целей в исходном проекте Flare. Читать дальше…