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

Публикации

Встречайте MadCap Mimic и MadCap Capture

23.06.2014

00Сегодня мы продолжим знакомить вас с продуктами компании MadCap Software. MadCap Mimic и MadCap Capture – инструменты для работы с мультимедиа. С ними можно легко создавать видеоролики, симуляторы программного обеспечения и делать качественные скриншоты с необходимой обработкой, причём обновлять всё это будет легко и быстро, т.к. продукты основаны на технологии единого источника. Обновите, например, ссылки и номер версии продукта в рабочем проекте, и они автоматически обновятся в видеороликах и на скриншотах сразу во всех форматах, в которые вы выводили свой проект. Не правда ли, это похоже на чудо? Кстати, все ролики и рисунки на сайте www.madcapsoftware.com были сделаны с помощью этих продуктов.


 

MadCap Mimic

MadCap Mimic – лёгкий в использовании инструмент для симуляции программного обеспечения и работы с мультимедиа, позволяющий создавать полностью интерактивные фильмы, видеоролики, симуляторы ПО, презентации и руководства к программному обеспечению или системам. Читать дальше…



Как стать техническим писателем API

20.06.2014

20.06.14Мы решили не обойти вниманием в нашем блоге ещё один актуальный вопрос технического писательства – документацию для API. Уже любимая нами Сара Мэддокс, технический писатель API компании Google, снова готова поделиться опытом.


 

Один мой знакомый технический писатель недавно спросил, если ли у меня советы, как стать техническим писателем API. Это человек, который пишет документацию, ориентированную на разработчика и описывающую программный интерфейс приложения (API), набор средств для разработчиков программного обеспечения (SDK) и другие инструменты, которые разработчики используют, чтобы заставить одно приложение «общаться» с другим. Я могу поделиться некоторыми советами.

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



Как создать FAQ-страницу для лучшей SEO-оптимизации, просмотров и результатов

18.06.2014

00Недавно мы рассказывали вам, как НЕ стоит создавать FAQ-странички. Юмор юмором, но страница вопросов и ответов может стать отличным инструментом продаж (если она правильно построена). Давайте попробуем научиться создавать такую страницу FAQ.


 

Могу утверждать, что FAQ-странички (на сайте), сделанные традиционным способом, – это глупейшая задумка.

А что является традиционным способом? Всё просто – компания перечисляет 5-15 (в среднем) наиболее часто задаваемых вопросов и сразу же на каждый даёт ответ предложения в 2-3… и обычно не самый лучший ответ.

Почему это плохая идея? Вот несколько причин:

  1. Мы живём в информационную эпоху. Потребители при посещении веб-сайта ожидают, что им дадут информацию, причём много. Вообще, традиционные FAQ-страницы – скудные порции этой информации, и не создадут с читателем доверительных отношений с жаркими обнимашками.
  2. С точки зрения SEO, страницы веб-сайта наиболее эффективны, если они тематические (с акцентом на центральной тематической/ключевой фразе). FAQ-страницы, следовательно, содержат несколько «тем», что мало чего даёт поисковым системам и снижает качество информации. В эру пингвина и панды [фильтры поисковых систем от компании Google; прим.пер.] в большинстве случаев такие страницы просто отфильтруются.
  3. Если компания агрессивно подходит к FAQ-странице и отвечает на огромное количество вопросов, страница может растянуться оооооооочень далеко, что скорее всего отпугнёт читателя.
  4. Каждый бизнес переживает «переломный момент», когда дело доходит до общего числа просмотров страниц. По существу, как руководитель бизнеса, вы должны смотреть на просмотры страницы как «свидание» на перспективу. С каждым свиданием (каждый кусок контента, который потребляют, будь то текст, видео, и т.д.) вы двигаетесь на один шаг ближе к конечной цели – «свадьбе» (получение нового клиента). FAQ-страницы традиционно является одним из «свиданий», которое, как вы можете себе представить, точно не слишком поможет людям пожениться 🙂

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



Встречайте MadCap Lingo

16.06.2014

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


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

MadCap Lingo является первым полностью интегрированным инструментом для автоматизированного перевода (CAT – computer-aided translation) и управления рабочим процессом, разработанный для автономного использования либо работы совместно с MadCap Flare для оптимизации процесса перевода.

Решение для оптимизации рабочего процесса для авторов и специалистов по документации

  • Улучшенный рабочий процесс и возможности рецензирования для команд, работающих с документацией, и переводчиков
  • Легко упаковать и отправить контент с Упаковщиком Проекта (Project Packager)
  • Обеспечивает целостность проекта и устраняет риск повреждения контента и форматирования
  • Отчёты по статистике, прозрачность процесса перевода и расходов
  • Расширенные функции, такие как конвертирование переменных в текст

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



Записи докладов конференции Гипербатон

11.06.2014

0124 мая прошла конференция «Гипербатон» и сегодня на сайте компании появился краткий отчёт о мероприятии и записи докладов. Спасибо компании Яндекс за интересную конференцию и за организацию площадки для живого общения технических писателей!



Как создать жуткую ЧаВо-страницу

11.06.14Страничка часто задаваемых вопросов – мощный инструмент выстраивания коммуникации с клиентом, зачастую незаслуженно забытый. Но если вы взялись за создание такой страницы, не переусердствуйте. И ни в коем случае не следуйте советам Сьюзен Сент-Мор.


Cтраницы ЧаВо – ещё один отличный способ продвижения вашего бизнеса, не так ли? Не берите в голову, что клиенты и возможные клиенты действительно могут спросить. Это просто страница, где вы можете указать «вопросы», которые вы бы хотели, чтобы ваши клиенты спрашивали, поэтому дам вам несколько советов, которые необходимы для увеличения продаж.

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



Встречайте Contributor и Analyzer от MadCap!

09.06.2014

00Представляем вашему вниманию очередные два инструмента от компании MadCap, с помощью которых автоматизируются, упрощаются и качественно улучшаются такие процессы, как совместная работа над документом авторов, редакторов, рецензентов и руководителей – это обеспечивает MadCap Contributor, и аналитика документации – за этот процесс отвечает MadCap Analyzer.


 

MadCap Contributor

С MadCap Contributor каждый сотрудник вашей организации сможет легко рецензировать документацию и вносить в неё свой вклад. Руководители и эксперты по предмету (ЭП) могут редактировать и рецензировать топики, создавать примечания и обновлять контент с помощью простого, лёгкого в использовании интерфейса. Тесная интеграция с MadCap Flare делает MadCap Contributor необходимым инструментом в процессе доводки и рецензирования документации.

Добавление и просмотр контента каждым сотрудником вашей организации Читать дальше…



Новостному блогу компании ПроТекст исполнился год!

06.06.2014

blog protextДорогие друзья!

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

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

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


С помощью средств, предоставляемых компаниями Яндекс и Google, мы собрали статистику по просмотрам публикаций нашего блога, и получили своеобразный топ-5 наиболее популярных заметок за последний год: Читать дальше…



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

04.06.2014

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


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



Об использовании ручки и бумаги

02.06.2014

02.06.14Известный блоггер и контент-менеджер Скотт Несбитт занимается тем, что помогает компаниям правильно организовать рабочие процессы по созданию, улучшению и хранению контента. Одним из, казалось бы, незначительных, способов по улучшению этих процессов оказался способ делать заметки. Грамотные заметки помогут значительно сократить время написания контента, не забыв при этом ничего важного.


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

Знаю, во времена ноутбуков, планшетов и смартфонов это звучит немножко абсурдно, но это так.

Бумага, как бы она не была архаична, может быть весьма полезна. Возможно, написанное от руки не так постоянно, как электронное (или вы можете поспорить, что оно более постоянно), у бумаги есть свои преимущества. Читать дальше…