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

БЛОГ

Проблема документирования: является ли структурированный контент залогом значительных улучшений?

24.08.2016

0110 обстоятельств для внедрения DITA на предприятии

Даже сравнительно небольшая компания или организация генерирует множество документов. Когда вы сталкиваетесь с более крупным контекстом, то имеете дело с тысячами или даже миллионами страниц документации, отчётов, маркетинговых материалов, регулярными документами о соответствии законодательству, презентациями… ошеломляющий объем контента. Этот контент со временем станет огромным капиталом и будет рассматриваться как значимое, ценное имущество компании. Почему? Потому что этот контент — ваша первая линия взаимодействия с клиентами, он позволяет таким группам, как HR и поддержка пользователей работать гладко и эффективно, и он представляет собой одновременно интеллектуальную собственность и опыт вашей организации или компании. Но также очень часто он расположен в таких неструктурированных средах для авторинга как файлы Microsoft Word, что делает практически невозможным централизованно управлять этими фондами.


К счастью, есть централизованное решение, основанное на открытых стандартах, масштабируемое и очень экономичное. Построенное на стандарте Darwin Information Typing Architecture (DITA), разработанном IBM для решения их собственных проблем с документацией, это решение представляет собой залог значительных улучшений относительно устаревших моделей создания и управления находящегося в эксплуатации контента, которые сегодня всё ещё широко используются. Когда DITA интегрируется с окружением для авторинга/управления (компонентная система управления контентом, или CCMS), этот стандарт предлагает решение с заделом на будущее решение буквально всех ваших проблем, связанных с управлением документацией. Десять обстоятельств, указанные ниже, показывают масштабируемость, гибкость и значительную экономию средств при переходе на DITA CCMS. Читать дальше…


Стратегические заметки по переносу контента в DITA CCMS

19.08.2016

01Мы возвращаемся к одной из любимых тем – структурированный контент и DITA. Мы уже рассказывали о плюсах структурного подхода к контенту, а сегодня хотим рассмотреть, какие сложности могут вас ожидать при переходе к подобной стратегии.


После того, как вы решите, что разумно было бы управлять контентом в масштабах предприятия, вы столкнётесь с целым рядом острых вопросов, касательно стратегии перехода к структурированному контенту, к примеру, к DITA CCMS. Один из самых важных вопросов – что делать с уже существующим контентом. К сожалению, волшебной кнопки «Перенести всё» не существует. Если учесть разнообразие форматов контента (Word, FrameMaker, PPT, PDF, онлайн-приложения, базы знаний и т.д.) и количество разрозненных мест его хранения (локальные компьютеры, сетевые диски, общие хранилища), перенос контента покажется очень и очень страшным зверем. Но есть и хорошие новости – возможности переработки существующего контента и рабочих процессов всё же существуют. Читать дальше…


Акция: 10% скидка на курс

15.08.2016

1 09 16А у вас просыпается к 1 сентября желание учиться? ?Воспользуйтесь скидкой -10% на курс «Разработка технических текстов и документации» и получите новую профессию!

с 15 августа по 15 сентября мы предоставляем скидку 10% на курс «Разработка технических текстов и документации». Для получения скидки необходимо оплатить обучение в этот период. Записывайтесь через форму на странице курса! Есть вопросы? Звоните нам по тел. +7-925-328-76-00


Как использовать Google Analytics для наполнения сайта

12.08.2016

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

Вы задумываетесь о создании блога своей компании, но не знаете, кто бы писал для него материалы? Наши специалисты с удовольствием помогут Вам!

Чтобы стратегия контент-маркетинга была успешной, её нужно подкреплять данными. Так, если стратегия не подтверждена чем-то реальным, она вряд ли увеличит продажи, приведёт новую аудиторию или поможет в чём-то важном.

Как писатель и редактор я использую Google Analytics и получаю точные цифры, как и на что реагирует аудитория, чтобы усовершенствовать свои методы. Читать дальше…


Первый Доквариум. Запись вебинара

10.08.2016

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

Как прошёл вебинар:

  • Мы выслушали рассказ с презентацией Анастасии Тян из компании АСКОН об её опыте использования MadCap Flare. Анастасии задали множество вопросов, на которые она ответила, продемонстрировав глубокое знание возможностей инструмента.
  • Александр Денисов, руководитель группы разработки документации компании NAUMEN, рассказал о том, как он и его коллеги используют MadCap Flare. Обсудили проблему задания ролей для документации, которая возникла в его работе.
  • Валерий Ледовской, технический директор компании «ПроТекст», показал, какими инструментами мы пользуемся при выполнении проектов по локализации программного обеспечения и переводах документации на аутсорсе.
  • Илья Дмитриенко, технический писатель из «Лаборатории Касперского», рассказал, как и для чего в компании используют инструмент Autor-it.
  • Обсудили планы на будущее.

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


Зачем техническому писателю разбираться в Google Analytics

05.08.2016

09Маркетинг сегодня вышел на первый план. Нужно не только создать продукт, но и суметь его продать. То же самое относится и к контенту. Каким бы великолепным ни был документ, он бессмыслен, если аудитория его не увидит. Помочь нам понять, что хочет аудитория и в каком виде она хочет это получить, призваны различные инструменты аналитики. Сегодня мы поговорим о самом популярном из них – Google Analytics, и узнаем, зачем необходимо уметь разбираться в нём. А в следующем посте нашего блога вы найдёте информацию о том, как писателю использовать Google Analytics для лучшей веб-документации.


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


Спецификации, ложь и видео: Документальный контроль фильмов

29.07.2016

NoJarJarОдин из главных драйверов любой работы – это контроль за её выполнением. А так как «офис без бумажек» пока ещё остаётся утопией, этот самый контроль нужно ещё и задокументировать. А иногда сделать это очень и очень непросто.


Пока я проводил исследования лазил в гугле, чтобы написать эту статью, я пребывал в шоке. В шоке, потому что узнал, что фразы «документальный контроль видео» и «документальный контроль фильмов» в гугле не найти [это явление получило название Googlenopes – прим.пер.]. Ну, правда, нашлось восемь результатов на запрос «контроль версий видео», но (а) восемь результатов во всем Интернете – это даже не смешно и (б) контроль версий и документальный контроль – не одно и то же. Контроль версий означает, что версия Б хранится отдельно от версии А. А документальный контроль означает (среди многого другого), что все мои пользователи используют версию Б видео, и ни один из них не использует версию A. Читать дальше…


Сравнение популярных редакторов для совместной работы над технической документацией: MadCap Flare, EasyDITA, Dr.Explain

21.07.2016

00Автор статьи: Александра Лопина, технический писатель компании Naumen – одна из выпускниц нашего учебного курса. Статья является одной из трёх практических итоговых работ. Спасибо Александре за качественную работу и предоставленную возможность опубликовать сравнение популярных инструментов для технических писателей.


Введение

В статье мы расскажем о трёх популярных продуктах для совместной работы над технической документацией: MadCap Flare, EasyDITA и Dr.Explain. Каждый из них в той или иной степени реализует принципы единого источника: повторное использование контента и его отделение от форматирования, публикация в различные форматы из одного проекта-источника. Эти принципы существенно экономят время разработки документации и помогают поддерживать единый стиль текста.

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


Первый «Доквариум» пройдёт 28 июля

20.07.2016

ДоквариумТехнические писатели – люди не очень публичные. Профессия наша – новая (хоть уже и не совсем), книг на русском языке и «живых» форумов почти нет, в вузах наших коллег не обучают, и вообще, всяческих сведений маловато. Хорошо, если в вашей компании работают несколько технических писателей, и вы можете пообщаться по профессиональным вопросам хотя бы друг с другом. Увы, подавляющему большинству технических писателей приходится «вариться в собственном соку» и решать все свои вопросы самостоятельно.

За последнее время мы уже сделали несколько шагов для исправления ситуации: создали учебный курс, в котором много времени отводится на общение с преподавателем, ведём блог с полезными материалами и периодически организуем конференции. Но при этом «живого» общения всё равно остаётся очень мало, поэтому сейчас мы решили сделать ещё один шаг навстречу коммуникациям.

Итак, мы объявляем о создании площадки для общения и обмена опытом между техническими писателями! И называется она «Доквариум». Читать дальше…


Адвокат пользователя: лучше приносить пользу, а не внушать восхищение

15.07.2016

strСегодня мы представим вам нового автора уже известного нам цикла статей «Адвокат пользователя». Фил Девис всю жизнь работает над тем, чтобы улучшить жизнь пользователей и решил поделиться некоторыми наблюдениями.


В «Адвокате пользователя» всё меняется. Нила завалили требованиями графиков запуска и конференц-презентаций. Я мог бы весь день читать его остроумные анализы, но теперь моя очередь добавить что-то к вдумчивой, проницательной практической многолетней  работе Джеффа, Марка и Нила.

Так кто же этот новый парень? Я не собираюсь занимать чьё-то место и не могу утверждать, что буду идейным лидером или гуру. Я работал в качестве технического писателя 20 лет. Я начал в сфере аппаратных средств, программного обеспечения, руководил командой писателей, и теперь я сольный писатель и отвечаю за производство документации, интеграцию и распределение продуктов более 10 лет, API – более 12 лет, и заказных фирменных решений для оценки ребрендинга клиентов по всему миру, а также играю свою роль во внутренних и внешних релизах. Читать дальше…