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

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

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

27.01.2017

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

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

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

Писатели знают, что не могут удовлетворять каждый раз потребности каждого идеально, так что они используют ссылки и другие механизмы, чтобы помочь читателям отклониться, когда им это требуется. Например, если у вас есть Модель А, делайте это. Если у вас Модель Б, делайте это. Поддержка отклонений помогает читателям достигать их целей и помогает удержать читателя в собственном контенте автора или другом предпочтительном контенте вместо отклонения куда-то в другое место. Читать дальше…



Алгоритмы структурированного писательства в процессе публикации

17.11.2016

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


Всё структурированное писательство в конечном итоге должно быть опубликовано. Публикация структурированного контента — это преобразование его из домена, в котором оно было создано (домен объекта, домен документа или абстрактная часть домена носителя), в наиболее определённую часть спектра домена носителя: точки на бумаге или на экране.

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

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



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

19.08.2016

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


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



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

30.06.2016

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

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


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

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

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



Применение продуктов MadCap Software на отечественном софтверном производстве на примере компании АСКОН

23.06.2016

00Сегодня мы публикуем рассказ одного из наших клиентов – Анастасии Тян, технического писателя из компании АСКОН – об их опыте использования продукта MadCap Flare и Lingo. Этими продуктами в компании начали пользоваться ещё до того, как компания ПроТекст стала партнёром MadCap Software, и пользуется по сей день, не забывая обновлять их до актуальных версий, чтобы задействовать все преимущества программного обеспечения.


АСКОН — крупнейший российский разработчик инженерного программного обеспечения и интегратор в сфере автоматизации проектной и производственной деятельности. В продуктах компании воплощены достижения отечественной математической школы, 26-летний опыт создания САПР и глубокая экспертиза в области проектирования и управления инженерными данными в машиностроении и строительстве. Программное обеспечение АСКОН используют свыше 9000 промышленных предприятий и проектных организаций в России и за рубежом.

В АСКОН MadCap Flare используется для написания и оформления справочной документации к новым продуктам —  к системе информационного моделирования Renga Architecture (справка) и системе управления проектированием Pilot-ICE (справка). Читать дальше…



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

29.05.2016

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

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


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

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

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



Представляем MadCap Flare 12!

25.03.2016

01Компания ПроТекст, прямой поставщик продуктов компании MadCap Software для организации технического документирования по России и ближнему зарубежью, представляет новую версию флагманского продукта этой компании — MadCap Flare 12. Одновременно с выпуском новой версии MadCap Flare производитель обновил связанные с ним продукты — MadCap Contributor 8 для рецензирования проектов и MadCap Analyzer 9 для анализа проектов, чтобы учесть новые возможности документирования MadCap Flare 12 в своей линейке продуктов. Кроме того, в MadCap Contributor 8 появилась возможность бесплатного рецензирования проектов по техническому переводу, осуществляемых с использованием MadCap Lingo. Актуальные версии продуктов MadCap Software всегда есть в наличии в нашем интернет-магазине.


_1Одна из моих любимых новых функций упрощает создание отзывчивого контента. Это даёт возможность пользователям выбирать и разрабатывать окружение с отзывчивой разметкой с помощью нового удобного в использовании редактора отзывчивой разметки.

— Денис Кадилак, архитектор информации и менеджер команды, Blackbaud Читать дальше…



Алгоритмы: Отделение контента от форматирования

10.03.2016

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

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


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



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

19.02.2016

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


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

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



Представляем MadCap Doc-To-Help 3 и MadCap Mimic 8 (+ акция)

14.11.2015

00Компания «ПроТекст» представляет новинки компании MadCap Software — полностью переработанные новые версии MadCap Doc-To-Help 3 и MadCap Mimic 8, а также утилиту для импорта контента из AuthorIt в MadCap Flare. Все эти продукты по ценам производителя можно приобрести в нашем интернет-магазине. Кроме того, в связи с запуском новых продуктов MadCap Software объявляет временную скидку до 30 ноября 2015 г. в размере 100 долларов США на каждую постоянную лицензию на MadPak Professional Suite, MadCap Flare и MadCap Doc-To-Help.


Doc-To-Help 3

С помощью Doc-To-Help мы интегрировали нашу справку в приложение. Благодаря Doc-To-Help мы осуществили централизованный подход к управлению всем контентом портала помощи (справочник, руководство пользователя, процедуры и т.д.), который создаётся разработчиками документов и экспертами по предмету из различных отделов.

Дорин Мэрсон, специалист по техническому документированию, GSOC Читать дальше…