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

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

Единый источник (часть 2)

07.05.2014

07.05.14Заканчиваем публикацию на тему единого источника. Возможно, она побудит вас задуматься о возможности перехода на эту технологию.


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

  • Маркетинговые материалы;
  • Онлайн-справка;
  • Учебные материалы;
  • Руководство.

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

Зачем озадачиваться единым источником?

Основные аргументы за технологию единого источника – стоимость и постоянство. Читать дальше…



Единый источник (часть 1)

05.05.2014

05.05.14Много внимания в публикациях мы уделяем системе DITA и связанным с ней инструментам. При этом часто употребляется термин «единый источник». Что же конкретно подразумевается под этим понятием? Небезызвестная нам Сьюзен Бодник может ответить.


Передача информации становится все более сложным делом, так как информация должна адаптироваться к новым технологиям поставки контента. Информация передаётся в различных форматах и для разных аудиторий. Если вы ищете решение проблемы поставки контента в нескольких конечных форматах и для различных аудиторий, возможно, вас заинтересует единый источник. Технология единого источника – процесс, при котором вы создаете контент в одном общем источнике, обычно в формате XML. В этом едином источнике вы можете использовать процессы, которые публикуют контент в нескольких форматах. Например, ваши документы можно опубликовать как интерактивную справку (chm), PDF или HTML. С помощью единого источника вам нужно всего лишь один раз создать контент, а потом использовать его в многочисленных типах выходных документов.

Как единый источник мне поможет?

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



Шесть советов по написанию веб-контента

03.02.2014

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


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

Выберите правильный заголовок для статьи или сообщения в блоге

Заголовок – первое и самое важное впечатление, которое вы можете произвести на читателя. Именно по заголовку читатели принимают решение читать или не читать веб-страницу. Убедитесь, что заголовок точно описывает содержание. Чтобы быть уверенным, что веб-страница будет замечена поисковыми системами, используйте в заголовке ключевые слова для лучшей SEO-оптимизации.

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



Техническое писательство и DITA

31.01.2014

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


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

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