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

Публикации

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

27.01.2017

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

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

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

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



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

17.11.2016

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


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

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

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



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

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Статья входит в цикл «Понимание и применение структурированного писательства».

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


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

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

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



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

07.04.2016

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

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


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

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



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

10.03.2016

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

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


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



Качество в структурированном писательстве

03.02.2016

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

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


Когда я говорю программистам о том, чем занимаюсь, они часто спрашивают меня, чем же так важно структурированное писательство. У машин так хорошо получается читать человеческий язык, утверждают они, что семантическая разметка в качестве помощи машине стремительно становится бессмысленной. Но структурированное писательство — оно не в помощь машине. Оно для привлечения машины в помощь писателю. И больше всего писателю требуется помощь с качеством.

Роботы, которые читают

Машины действительно всё лучше и лучше понимают человеческий язык. Подход, который называется Глубинным обучением, всё больше становится основной технологией для таких компаний как Facebook, Google и Baidu как для понимания языка, так и для распознавания речи. Читать дальше…



Структурированное писательство: Внедрение домена управления

22.01.2016

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

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


До сих пор я говорил о трёх доменах, через которые проходит контент и в которых он может быть записан: домен носителя, домен документа и домен объекта. Но существует четвёртый домен, который внедряется в эту картину структурированного писательства: домен управления.

Почему я называю домен управления навязанным? Потому что домены объекта, документа и носителя — о записи контента как такового, а домен управления — не о контенте, а о процессе управления им. Читать дальше…