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

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

Первый взгляд: Adobe Technical Communication Suite (релиз 2017)

10.02.2017

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


Инструмент для контента, который стал больше, лучше и круче

Технический писатель. Разработчик информации. Разработчик инструкций. Менеджер по контенту. Производитель. Менеджер по документированию. Копирайтер. Эксперт. Не имеет значения, где вы сталкиваетесь с производством контента, перед вами наверняка встаёт проблема выбора правильных инструментов для управления постоянно изменяющимся и всё возрастающим потоком работы. Вы создаёте контент для традиционной печати или вывода в PDF, помощь, встроенную в приложение или для клиентов разрабатываете порталы, которые содержат обучение, самостоятельную помощь и другой контент? Adobe Technical Communication Suite (релиз 2017) предлагает для этого гораздо больше, чем кажется на первый взгляд. Читать дальше…



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

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, онлайн-приложения, базы знаний и т.д.) и количество разрозненных мест его хранения (локальные компьютеры, сетевые диски, общие хранилища), перенос контента покажется очень и очень страшным зверем. Но есть и хорошие новости – возможности переработки существующего контента и рабочих процессов всё же существуют. Читать дальше…



Алгоритм повторного использования

30.06.2016

00Статья входит в цикл «Понимание и применение структурированного писательства».

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


Повторное использование контента в различных контекстах становится одним из основных драйверов структурированного писательства, особенно в виде широко распространённого применения DITA. Основные мотивы для повторного использования контента — снижение затрат (уход от создания одного и того же контента множество раз и гарантия связности или соответствие нормам (посредством непременного применения контента из подтверждённого источника).

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

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



Алгоритм единого источника

29.05.2016

00Статья входит в цикл «Понимание и применение структурированного писательства».

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


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

  • Единый источник: Представление одного документа на различных носителях.
  • Повторное использование контента: Использование одного контента для создания различных документов.
  • Единый источник правды: Гарантия того, что каждая часть информации записана только единожды.

В этой статье мы рассмотрим единый источник так, как это определено выше. Читать дальше…



Вторая волна DITA

19.02.2016

00Некоторое время назад в нашем блоге частенько появлялись статьи о стандарте DITA. Например, эта — ключевая статья о том, что такое DITA и зачем нам это нужно. Это была первая волна DITA (по крайней мере, в то время она докатилась до нас 🙂 ). А теперь говорят о новой, второй волне DITA. Давайте посмотрим, что она собой представляет.


У вас есть DITA. Что теперь?

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



Обзор продукта: easyDITA добавляет больше потрясающих функций и становится лучшей в своём сегменте

22.10.2015

01Примечание автора Джекки Сэмюэлс (Jacquie Samuels): я взяла демонстрационную версию нового релиза easyDITA, чтобы оценить её для этого обзора. Я не получила никакого вознаграждения от easyDITA для написания этого обзора. Меня никак не поощряли, прямо или косвенно, ни со стороны Jorsek, ни со стороны владельцев easyDITA, чтобы получить положительный отзыв. Это моё актуальное, профессиональное мнение.


easyDITA была середнячком на поле DITA CCMS (CCMS — компонентная система управления содержимым) на протяжении последних нескольких лет. Предлагалась привлекательная цена наряду с притягательной простотой и удобством простого в использовании управления, которые послужили причиной хороших продаж. Но в отличие от множества приверженцев DITA, easyDITA не обладала функциональностью, достаточной для того, чтобы сделать её выбором номер один.

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



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

20.07.2015

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


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

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



Бассейн для всех: Не только технические писатели могут использовать DITA

22.01.2015

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

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

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

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



Тематическое исследование Huawei: Решение коммуникационных проблем по всему миру (часть 2)

21.11.2014

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


Продолжаем перечислять обязанности службы технической коммуникации:

2. Обеспечивать поддержку создания конкурсных и маркетинговых документов.

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