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

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

Обзор продукта: 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 не только в среде технических писателей, разбирающихся в этой технологии от и до, но и среди других технических специалистов, участвующих в разработке продукта и рецензирующих создаваемую документацию.

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

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



OASIS утверждает стандарт обмена локализуемыми данными и сопутствующей информацией XLIFF 2.0

24.11.2014

24.11.14Возвращаемся к одному из самых востребованный на данный момент направлений – локализации. Для тех, кто занимается или планирует заниматься локализацией на профессиональной основе, у нас хорошие новости – в августе этого года была утверждена новая версия стандарта, который позволит вам сэкономить много сил и средств.


IBM, Microsoft, Oracle, SDL, Symantec, научно-исследовательский центр локализации университета Лимерика и другие повышают совместимость между коммерческими и открытыми инструментами локализации.

Консорциум OASIS по международным открытым стандартам объявил об утверждении XML стандарта обмена локализируемыми данными и сопутствующей информацией XLIFF 2.0. Делая возможным взаимодействие между инструментами локализации, XLIFF освобождает издателей от сложности и дороговизны предварительной обработки локализуемого контента из собственных форматов. XLIFF 2.0 стал официальным стандартом OASIS – статус, который означает высший уровень одобрения. Читать дальше…



Техническая документация: разбираемся в спецификациях S1000D и DITA

27.10.2014

27.10.14В своих публикациях мы уделяли большое внимание архитектуре DITA, но хотелось бы отметить, что это не единственный полноценный стандарт для создания технической документации. Технический консультант и специалист по разработке структурированной документации Себастьен Клима рассказывает об основных преимуществах разных спецификаций.


 

Спецификация S1000D

S1000D – это спецификация для производства технической документации, связанной с эксплуатацией (ТОиР – Техническое обслуживание и ремонт), основанная на концепции модулей данных и хранящаяся в общей базе данных эксплуатационной документации (ОБДЭ). Эта спецификация полностью отвечает требованиям технического обслуживания для всех видов воздушных, наземных и водных механизмов, которые содержат большое число компонентов. Таким образом, спецификация S1000D позволяет организовывать информацию в модульной форме, повторно использовать модули данных, избегать дублирования информации, что подразумевает значительную экономию денежных и временных затрат при создании и управлении публикациями. Читать дальше…



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

30.05.2014

00В наши дни постоянно наблюдается рост числа видов и подвидов устройств, с которых мы постоянно потребляем контент: обычные компьютеры с большими мониторами уже давно вытесняются удобными компактными планшетами с экранами 7-10 дюймов, смартфонами с диагональю от трёх дюймов, ваш контент могут загрузить даже с плееров и электронных книг! Чтобы контент оставался одинаково удобным для чтения и привлекал максимально широкую аудиторию, компаниям приходится следить за изменениями в мире технологий, подключая к своему производству всё новые форматы, но и не забывая о тех пользователях, которые любят просматривать информацию с больших экранов мониторов, распечатывать её или же привыкли покупать глянцевые журналы. Чтобы оставаться в тренде, но при этом тратить на создание и публикацию контента разумное количество времени, нужен хороший инструмент. Желательно один, который может справиться со всеми задачами. Мы поискали такой инструмент в России и не нашли его. Тогда мы решили поискать в других странах. Мы исследовали несколько продуктов для работы технических писателей, производимых и использующихся по всему миру, и остановили свой выбор на линейке продуктов американской компании MadCap Software. Эта компания существует на рынке уже много лет, имеет представительства по всему миру и постоянно дорабатывает и улучшает свои продукты.
С помощью продуктов MadCap можно не только создавать и публиковать контент из единого источника во все необходимые форматы сразу нажатием одной кнопки, но и совместно рецензировать и редактировать контент; локализовывать тексты на разные языки, в том числе и азиатские, локализовывать видео и изображения; создавать и редактировать видеоролики и изображения, причём делать всё это максимально автоматизировано и удобно.
Эти продукты уже известны многим в России, но пока далеко не всем. Компания ПроТекст в скором времени станет официальным представителем компании MadCap в России, мы будем поставлять продукты и впервые в нашей стране оказывать клиентам техподдержку по этим продуктам на русском языке. Если продукты MadCap вызовут значительный интерес на российском рынке, то через некоторое время мы планируем локализовать интерфейс и документацию к ним на русский язык. Сегодня мы начнём знакомить вас с линейкой продуктов MadCap, и первой программой станет Flare – флагманский продукт, с которым идеально интегрируются другие компоненты линейки программного обеспечения от MadCap. Надеемся, что вы проникнетесь продуманностью и функциональностью этого программного обеспечения, как и мы, а сотрудники нашей компании постараются сделать всё, чтобы российским пользователям программных продуктов MadCap стало комфортнее пользоваться этим полезным инструментом.

Итак, поехали! Читать дальше…



Кто переходит на DITA, а кому не надо и пытаться?

14.05.2014

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


«Обещания» системы DITA сделать контент более структурированным и простым для публикации обращены к огромному количеству компаний, которые работают с огромным количеством технического контента. На данный момент на DITA переходят очень многие предприятия, где работают от одного техписа до компаний более чем 500 штатными писателями. Так подойдёт ли DITA вашей организации, и как понять, что она вам не подходит?

Кто переходит на DITA?

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



Зачем мне нужна DITA? (часть 2)

25.04.2014

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


DITA повышает удобство использования

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

Разделение контента на отдельные, часто используемые, но чёткие топики делает его более доступным для поиска. Пользователи могут перемещаться прямо к необходимой им информации, читать только соответствующую информацию (потому что остальное отбрасывается), а затем заниматься своими делами.

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



Зачем мне нужна DITA? (часть 1)

23.04.2014

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


Дарвиновская Архитектура Типизированной Информации (DITA) является стандартом на базе XML, который используется в основном для технической и всё чаще и для других типов документации. Мы уже представляли вам статью «Что такое DITA и зачем нам это нужно?». Мы подробно остановились на «что», а теперь хотели бы ещё раз подчеркнуть «зачем». И это вопрос, который вам нужно задать себе, если работа над созданием технического контента – часть вашей ежедневной работы.

Ответ обманчиво прост: Никуда от этого не денешься; если вы не применяете DITA как стандарт документации, вы работаете гораздо медленнее и менее эффективно, чем должны бы.

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



Измените подход к написанию контента: альтернативы DITA (часть 2)

11.04.2014

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


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

SPFE: Разработка Марка Бейкера SPFE (Synthesis, Presentation, Formatting, and Encoding – Синтез, Презентация, Форматирование и Кодировка) является запросоориентированным структурированным авторским подходом, который многообещающе выглядит, но пока не имеет ни широкого распространения, ни поддержки. SPFE (или «spiffy», как называют его в англоговорящих странах) представляет собой архитектуру для построения структурированного авторинга и издательских систем, который использует функции базы данных XML в обход необходимости внедрения дорогого CCMS.

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