Разработка технической документации и технические писатели Технические писатели и разработка технической документации технические писатели в Телеграм 

 obmen_soobsheniyami.png Чат для технических писателей 
 Зарегистрируйтесь
Страницы: 1 2 След.
RSS
DITA - что это и для чего это надо?
 
Добрый день! Обнаружил в интернете следующее:
"
Цитата
Архитектура типизированной информации Darwin (Darwin Information Typing Architecture, DITA) — это основанная на XML технология, охватывающая весь цикл разработки, выпуска и доставки технической информации. Эта архитектура составлена из набора принципов, описывающих как создание модулей с «типизированной информацией» на уровне отдельных тем, так и использование этой информации, например в онлайн-справке или на веб-портале технической поддержки.

Основными элементами DITA — кирпичиками, из которых строится архитектура разбитой по темам информации, — являются определения типов XML-документа (DTD), а именно, «DTD тем». Несмотря на это, основополагающим принципом в архитектуре DITA является её расширяемость; DTD тем, как и любые схемы на их основе, — это лишь конкретные реализации принципов этой архитектуры.

Насколько я понимаю это тоже один из вариантов организации принципа "единого источника", это так? Нам нужно создать портал технической поддержки, подойдет ли DITA для этого?
 
Цитата
DTD (англ. Document Type Definition определение типа документа) — язык описания структуры XML-документа.

Сейчас идёт отказ от формата по ряду причин:

Он использует отличный от XML синтаксис.
Отсутствие типизации узлов.
На смену DTD пришёл стандарт консорциума W3C XML Schema.
Зачем использовать создание документов в формате, который устаревает?
 
В принципе, все идет к тому, что XML и станет супер-пупер-единым и сточником. Задача будет состоять только в корректной конвертации одного XML-формата в другой...
 
А разве DITA не использует XML? По-моему она как раз и построена на его основе, или я ошибаюсь?
 
Цитата
Добрый день! Обнаружил в интернете следующее:
"
Цитата
Архитектура типизированной информации Darwin (Darwin Information Typing Architecture, DITA) — это основанная на XML технология, охватывающая весь цикл разработки, выпуска и доставки технической информации. Эта архитектура составлена из набора принципов, описывающих как создание модулей с «типизированной информацией» на уровне отдельных тем, так и использование этой информации, например в онлайн-справке или на веб-портале технической поддержки.

Основными элементами DITA — кирпичиками, из которых строится архитектура разбитой по темам информации, — являются определения типов XML-документа (DTD), а именно, «DTD тем». Несмотря на это, основополагающим принципом в архитектуре DITA является её расширяемость; DTD тем, как и любые схемы на их основе, — это лишь конкретные реализации принципов этой архитектуры.

Насколько я понимаю это тоже один из вариантов организации принципа "единого источника", это так? Нам нужно создать портал технической поддержки, подойдет ли DITA для этого?
Посмотри здесь http://dita.xml.org/
http://www.oasis-open.org/committees/tc ... bbrev=dita
http://xmlhack.ru/texts/06/dita/dita.html
Последняя ссылка дает понимание для чего и зачем это надо
Цитата
Движение к переносимой технической информации
Архитектура типизированной информации Darwin (Darwin Information Typing Architecture, DITA) — это основанная на XML технология, охватывающая весь цикл разработки, выпуска и доставки технической информации. Эта архитектура составлена из набора принципов, описывающих как создание модулей с «типизированной информацией» на уровне отдельных тем, так и использование этой информации, например в онлайн-справке или на веб-портале технической поддержки.

Основными элементами DITA — кирпичиками, из которых строится архитектура разбитой по темам информации, — являются определения типов XML-документа (DTD), а именно, «DTD тем». Несмотря на это, основополагающим принципом в архитектуре DITA является её расширяемость; DTD тем, как и любые схемы на их основе, — это лишь конкретные реализации принципов этой архитектуры.

Данный документ содержит обзор технологии DITA: что это такое, и как её можно применять в создании технической документации. Заодно он является примером практического приложения этой архитектуры; он был полностью написан в виде XML, с использованием описанных здесь принципов.

Исторический обзор
Архитектура DITA и её DTD были разработаны сборной рабочей группой, образованной специалистами по поддержке пользователей, работающими в различных отделах IBM. После предварительного совещания в конце 1999 г., эта рабочая группа совместно разрабатывала архитектуру типизированной технической информации, общаясь при помощи сообщений в базе данных и еженедельных телеконференций. К 2001 г. разработка была завершена, и архитектура DITA использовалась на веб-сайте IBM developerWorks как альтернативная система XML-документации. Целью было извлечь максимум выгоды из представления документации в виде XML. Сейчас, когда новые разработки существенно улучшили гибкость и согласованность этой архитектуры, можно считать, что DITA успешно прошла этап начального прототипа.

Обмен информацией, управление инструментами и расширяемость
Документация к продуктам IBM занимает миллионы страниц, и с начала 1990-х вся она создавалась на основе IBMIDDoc — чрезвычайно сложного SGML-DTD, являющегося внутренним стандартом IBM. С самого начала рабочая группа оказалась перед вопросом: «Не будет ли достаточным просто сделать XML-DTD из IBMIDDoc, или взять какое-нибудь из уже существующих DTD, таких как DocBook, TEI или XHTML?» Чтобы смочь ответить на этот вопрос, нужно представлять себе сущность технической документации.

Во-первых, SGML и XML — это метаязыки: они позволяют сообществам описывать информацию, которой те располагают, по-разному — в зависимости от используемых ими способов создания, хранения и обработки этой информации. Поскольку представление знаний всегда очень сильно связано с внутрикорпоративной культурой и используемыми терминами, то большинство попыток создать универсальное DTD оказались либо незавершёнными, либо невостребованными. Идеальный обмен информацией — это обмен её семантикой и правилами преобразования между разнородными сообществами.

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

В-третьих, большинство попыток формализовать словарь описания документа (DTD либо схему) на самом деле являлись моделированием существующей информации, соответствующей текущим бизнес-процессам в компании, владеющей этой информацией. Недостатком такого подхода обычно является включение устаревших процессов в получающиеся DTD и словари. Идеальная расширяемость, применительно к DTD для технической информации (или любой другой, которая постоянно обновляется, соответствуя передовым технологиям), — это создание такого DTD, в которое заложен минимум предположений о системе обработки данных.

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

Основные черты архитектуры DITA
Как и предполагает слово «архитектура» в названии DITA, она включает определённые черты, которые позволяют объединять, организовывать и структурировать информацию:

Ориентированность на темы. Самая высокоуровневая из стандартных структур в DITA — это тема. Все более высокоуровневые структуры — это, как правило, часть контекста обработки темы, например структура организации печати или структура навигации по набору тем. Кроме того, темы сами по себе не образуют иерархически вложенную систему; чтобы её организовать, необходимы секции, которые определяют или поддерживают тему.
Многократное использование. Одной из основных задач, поставленных перед DITA, было уничтожение необходимости в копировании содержимого из одного документа в другой. Вместо этого DITA предлагает два новых уровня многократного использования существующих данных:
Многократное использование тем. Так как темы не могут вкладываться друг в друга, то любую тему можно повторно использовать в новом контексте. Авторы тем знают, что когда старая тема используется в новой информационной модели, архитектура сама позаботится об её корректной интеграции в новый контекст.
Многократное использование содержимого. Принятый в SGML метод объявления внешних сущностей, допустимых к многократному использованию, доступен и в XML, хотя и с определёнными ограничениями. Вместо этого в DITA сделан уклон в сторону другого способа многократного использования, также заимствованного из SGML: каждому элементу присваивается атрибут conref, который может указывать на любой другой такой же элемент, в той же теме либо в любой другой. Этот механизм ссылок начинает работать с базового элемента, поэтому внутри темы-ссылки — темы, содержащей элемент с атрибутом conref — в любом случае оказывается какая бы то ни было структура. Новое содержимое темы всегда соответствует по типу тому элементу, который оно замещает.
Специализация. Механизм классов в CSS указывает общее в форматировании всех элементов, соответствующих одному классу. Точно так же, любой элемент в DITA можно расширить, и его идентификатор будет добавлен к атрибуту класса нового элемента через его DTD. Тем самым, новый элемент всегда связан со своим непосредственным элементом-предком, и со всеми остальными элементами в своей цепочке специализации.
Специализация тем. Применительно к структуре тем, специализация — это естественный способ расширять общую тему в новые информационные типы (инфотипы), которые, в свою очередь, можно расширять в ещё более специальные виды информационных структур. Например, кулинарный рецепт, спецификация на материал, и статья в энциклопедии — всё это можно представить себе как подтипы общей темы «справка».
Специализация словарей. В соответствии с тем же принципом специализации, словарь элементов внутри общей темы (либо набора тем с общим инфотипом) можно расширять, внося в него элементы, отражающие конкретную область знаний, представляемую этими темами. Например, ключевое слово можно расширить до единицы веса в кулинарном рецепте, до шифра детали — в техническом справочнике, или до переменной — в справочнике по программированию. Спецсловарь, такой как конструкции программирования, можно ввести при помощи подстановки в любом месте, где допускаются корневые элементы. В результате этого весь словарь оказывается доступным в любой теме с инфотипом, соответствующим этой области знаний. Далее, при переносе тем из одного инфотипа в другой можно целиком заменить в этих темах один спецсловарь на другой — например, чтобы скрыть терминологию их области знаний от писателей, работающих с не относящимся к ней содержимым. При этом оба набора тем могут быть одинаково ценными для одних и тех же типов задач, таких как получение справочной информации.
Обработка на основании свойств. Модель DITA предоставляет метаданные и атрибуты, при помощи которых можно группировать и фильтровать содержимое тем; это облегчает создание для DITA систем управления содержимым (CMS), поисковых систем, фильтров-обработчиков и т.д.
Исчерпывающие метаданные облегчают поиск тем. Модель метаданных в DITA поддерживает все их стандартные категории, включённые в Дублинское ядро. Вдобавок к этому, метаданные в DITA позволяют применять к темам множество различных подходов по управлению содержимым.
Всеобщие свойства. Большинство элементов в DTD тем содержат набор всеобщих атрибутов, которые позволяют использовать эти элементы как селекторы и фильтры; также эти атрибуты поддерживают инфраструктуру ссылок на содержимое тем и многоязыковую поддержку. Вдобавок к этому, некоторые элементы, чьи атрибуты могут использоваться в широком диапазоне специальных приложений, были подвергнуты анализу, чтобы убедиться, что возможные значения этих атрибутов обеспечивают достаточно богатую платформу для специализации (при которой диапазон изменения значений может только сужаться, но не расширяться).
Извлечение выгоды из существующих тегов и инструментов. Вместо того, чтобы радикально менять привычные технологии, в DITA за основу были взяты общепринятые наборы тегов, и для работы с ней можно использовать обычные XML-инструменты.
Использование элементов из популярных языков. Основные элементы в DTD тем в DITA заимствованы из HTML и XHTML: их привычные имена, такие как p, ol, ul, dl и т.п., образуют структуру темы, схожую с обычным HTML. На самом деле, темы для DITA можно создавать в виде HTML, и они смогут отображаться в браузере без дополнительной обработки. Более сложные DITA-темы можно создавать в виде SGML, который будет приводиться обработчиком в формат, удобный для доставки, — например, XHTML, или любой другой XML-формат, ориентированный на возможности по обработке XML в конкретных браузерах. Далее, в DITA используется популярная табличная модель из OASIS (бывшая ранее в CALS).
Использование популярных и поддерживаемых инструментов. Модель обработки XML широко поддерживается в продуктах различных производителей. Механизм её расширения в DITA, основанный на классах, имеет общие черты с XSLT и CSS — определёнными Консорциумом Всемирной паутины (W3C) языками описания стилей, чья поддержка включена во множество редакторов, браузеров и средств обработки данных. Работа с темами DITA может вестись при помощи самого широкого набора инструментов — от условно-бесплатных до разработанных на заказ, практически на любой операционной системе.
Тема как основная архитектурная единица
В центре разнообразных архитектур онлайн-доставки информации неизменно стоит понятие о теме как об основной единице этой информации. Тема как единица информации — это описание одной задачи, или понятия, или пункта справки. Категория этой темы (понятие, задача или справка) образует её информационный тип (инфотип). Новый информационный тип вводится при помощи специализации на основе структур в общем DTD тем. Типизированными темами легко управлять из систем управления содержимым (CMS), потому что это автономные блоки информации, готовые к многократному использованию. Например, отобранные темы можно собрать вместе, упорядочить, и обработать в контексте доставки, чтобы сделать их доступными в нескольких доставляемых формах — таких, как набор недавно доработанных тем, передаваемый для проверки; набор тем справки, включаемый в приложение поддержки пользователей; или даже набор глав или разделов в буклете, который печатается по «списку покупок» пользователя или по результатам сделанного им поискового запроса.

Преимущества архитектуры DITA
За счёт разбиения всех данных на отдельные темы и специализации их типа, DITA позволяет применить к информационным массивам следующие преимущества объектно-ориентированной модели:

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

Данные и обработчики, отделённые от контекста, можно членить, создавая механизмы, схожие с объектно-ориентированными — например, можно переопределять преобразования, изменяя или дополняя их поведение.
Классификация элементов при помощи цепочки наследования образует всё более специальные и обычно всё более ограниченные типы. Эти типы всегда связаны через атрибут класса с единообразной моделью обработки или отображения данных.
Возможно наследование поведения элементов — новые элементы либо наследуют поведение от своих предков, либо связываются с новыми обработчиками, расширяющими базовое поведение.
При достаточной строгости и изобретательности некоторые из этих преимуществ применительно к наборам тем можно было бы получить и при помощи DTD. В частности, существуют механизмы членения, позволяющие получить по DTD книги её отдельные темы. В DITA возможен и противоположный переход: составление книги из набора DITA-тем. Однако, в обоих этих случаях возможность перехода лишь вторична по отношению к основному предназначению DTD: а именно, если вы создаёте книги, то наиболее разумным было бы использовать DTD, предназначенное для книг; если же вы создаёте темы, то более разумным было бы использовать DTD для тем, причём пригодное даже для больших наборов тем без ограничений на возможность их обработки.

Обзор DITA
Архитектура типизированной информации Darwin определяет ряд взаимоотношений между частями документа, обработчиками и сообществами пользователей информации. Ниже перечислены уровни в DITA, соответствующие целям, заложенным в её основное DTD — topic.

Уровни в архитектуре типизированной информации Darwin (DITA) Контексты доставки
справочная система печать отдельных глав веб-сайт, информационный портал
Структуры типизированных тем
тема понятие задание справка
Специализация словарей по типам информации
Типизированная тема: понятие задание справка
Включаемые словари: выделение; программы; программирование; пользовательский интерфейс
Универсальные структуры
метаданные таблица OASIS (CALS)

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

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

Контексты доставки
справочная система печать отдельных глав веб-сайт, информационный портал

Типизированные темы в DITA
Типизированная тема (тема с инфотипом) — это основной структурный уровень всей информации в DITA. Основа этой архитектуры — это структура темы и её специальные варианты — понятие, задание и справка. Дальнейшая специализация позволяет расширить архитектуру на другие типы тем.

Структуры типизированных тем
тема понятие задание справка

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

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

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

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

Специализация словарей по типам информации
Типизированная тема:  понятие задание справка
Включаемые словари:  выделение; программы; программирование; пользовательский интерфейс

Спецсловари, определённые в этом примере, включают следующие элементы:

Спецсловарь  Элементы  
выделение b, u, i, tt, sup, sub
программы msgph, msgblock, msgnum, cmdname, varname, filepath, userinput, systemoutput
программирование codeph, codeblock, option, var, parmname, synph, oper, delim, sep, apiname, parml, plentry, pt, pd, syntaxdiagram, synblk, groupseq, groupchoice, groupcomp, fragment, fragref, synnote, synnoteref, repsep, kwd
пользовательский интерфейс uicontrol, wintitle, menucascade, shortcut

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

Чтобы включить спецсловарь, нужно объявить эквивалентную сущность-параметр для каждого элемента, использованного в DTD, — такого, как тема или один из её специализированных вариантов, — и затем использовать в рамках модели содержимого, задаваемой этим DTD, сущности-параметры вместо непосредственных элементов. Потом, после подстановки сущности-параметра, соответствующего элементу, эта сущность переопределяются так, чтобы включать и сам элемент, и все производные от него элементы того же спецсловаря; поэтому всюду, где допускался исходный элемент, будут также допускаться и производные от него. В результате этого любую тему, не привязанную к конкретной области знаний, можно расширить на несколько разных областей одной лишь заменой набора включаемых сущностей, выполняемой при помощи DTD-«оболочки», формализующей расширения словаря на указанное семейство типизированных тем.

Универсальные структуры в DITA
Одной из целей, поставленных перед разработчиками DITA, было извлечение выгоды из многократного использования XML-структур общего назначения. В соответствии с этим, в DTD тем включена табличная модель OASIS (прежде известная как табличная модель CALS). Также включён определённый набор метаданных, непосредственно совместимых с моделями метаданных в некоторых других схемах и DTD.

Универсальные структуры
метаданные таблица OASIS (CALS)

В структуре метаданных определены служебная информация для документа и отдельных тем, DTD высокоуровневой обработки, и даже HTML-документы, приложенные к основному документу как вспомогательные либо как записи в базе данных.

Структура таблицы предоставляет семантические средства визуальной разметки содержимого тем. Поддержка табличной модели OASIS/CALS есть во многих популярных XML-редакторах.

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

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

Разработчики DITA постарались выбрать для элементов имена, знакомые по HTML и другим языкам разметки. Некоторые из имён были позаимствованы из промышленных DTD, поддерживающих большие SGML-библиотеки, — таких, как IBMIDDoc и DocBook.

Списки атрибутов, использованных в DTD тем, отражают ту же философию. Например, один из «всеобщих атрибутов», применимых к большинству элементов, — это importance, определяющий значимость или ценность как свойство многих специальных элементов. Так, в некоторых элементах специализированной темы-задачи этот атрибут используется с двумя допустимыми значениями: «optional» и «required». В других областях более уместно размечать элементы по важности как «high» или «low». Все эти возможные значения определены на уровне базовой темы.

Значение специализации
Компания может определить собственные специальные типы тем соответственно своим конкретным информационным потребностям. Например, группа разработчиков может выделить в три главных типа темы-справки справку по сообщениям, утилитам и API. Создав специальный тип тем для данных каждого рода, системный архитектор может обеспечить соответствие содержимого тем каждого типа их предназначению. Кроме того, XML-поиск по специализированным темам становится мощнее, допуская более узкие запросы. Так, пользователь может ограничить поиск только сообщениями или только API, либо он может искать по всем темам-справкам вообще.

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

В корпорации может быть набор различных DTD, единообразно представляющих описания различных типов информации; они демонстрируют значение специализации применительно к этим новым инфотипам.

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

На следующем рисунке отражено, каким образом сообщества владельцев данных на уровне тем могут специализировать их содержимое в соответствии с базовой архитектурой.
 
Все это интересно, а есть ресурсы посвященные этому вопросу? Планируем внедрять "единый источник", вот думаем DITA или Docbook, хотелось бы проконсультироваться.
Быть или не быть?
 
Занимаюсь внедрением DITA в своей компании вкупе с XML CMS

DocBook или DITA - однозначного ответа нет. После достаточно продолжительного анализа и проб, я остановился на DITA (как и многии брэнды такие как Nokia, Huway и т.д.). Для руководства компании готовил презентацию по этому поводу.
В принципе в DITA имеется ряд существенных преимуществ часть которых можно реализовать и в DocBook (но не все, например механизм специализации), но в DITA они изначально заложены.
Также переход DITA to DocBook реализуем в любой момент без особых проблем, а вот назад  придется фрагментировать докбуковские документы, убирать контекст, и делать карты.

Могу сказать что для таких XML технологий как DocBook, DITA, S1000D и т. д. рекомендуется дополнительно XML CMS, а они держат разные DTD в том числе и собственные кастомные разработки.

Вопрос выбора технологии не столь важен, сколь важен вопрос проектирования информационнй архитектуры.

Смотрите тут обсуждения DITA с форума Философт
http://forum.philosoft.ru/cgi-bin/forum ... ct=SF;f=37
 
Что Вы можете посоветовать для начинающего Dita-специалиста? С чего начинать построение информационной архитектуры? Есть ли примеры? И как начинать внедрять все это. :(
Быть или не быть?
 
Для начала что касается установки, настройки и азам работы советую почитать DITA for SOLO Writers
http://www.lone-dita.com/Portals/0/dita/ditaguide.pdf
 
Для начала устанавливается DITA Open Toolkit . Устанавливается XMLMind и DITA плагин к нему.
Для получения pdf и xhtml придется настроить XSLT .
Для получения PDF дополнительно используются FO- процессоры: XEP (платный), FOP (он бесплатный). Ранее плагин Idiom, который используется в вышеназванной доке работал только с XEP. Сейчас он уже идет в составе DITA OT 1.5 и работает с FOP.

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

Информационная архитектура это ведение информационных архитекторов, которые планируют топики, реюсинг, структуру комплекта документации его кастомизацию под клиентов, тезарус для реализации поиска и индексирования и т.д.
 
Спасибо начну пробовать, о результатах напишу! А какие примеры у Вас есть? Можно их получить?
Быть или не быть?
 
Есть документация моей компании которая сделана в DITA. Для начала необходимо пройти путь установки и настройки. А потом уже смотреть примеры...

Перевод введения в DITA
http://xmlhack.ru/texts/06/dita/dita.html

Книги
http://www.comtech-serv.com/publications.shtml#book3

Презентации DITA
http://www.slideshare.net/search/slides ... mit=Search
Здесь PDF-презентауии почему Nokia выбралы DITA
http://xml.coverpages.org/DITA-Openhouse2004-Nokia.pdf


DITA Language Specification v1.1
http://docs.oasis-open.org/dita/v1.1/CD ... ml#ditaval

Еще материал
http://www.ibm.com/developerworks/xml/library/x-dita1/
http://xml.coverpages.org/dita.html
http://www.oasis-open.org/committees/tc ... bbrev=dita
http://blogs.sun.com/coolstuff/feed/ent ... at=%2FDITA
http://www.idealliance.org/papers/extre ... ril01.html
http://norman.walsh.name/2005/10/21/dita

http://www.ibm.com/developerworks/xml/l ... index.html

Можно тут посмотреть про XML CMS
http://www.ditausers.org/tools/dita_xml_cms/
 
Цитата
Цитата
DTD (англ. Document Type Definition определение типа документа) — язык описания структуры XML-документа.

Сейчас идёт отказ от формата по ряду причин:

Он использует отличный от XML синтаксис.
Отсутствие типизации узлов.
На смену DTD пришёл стандарт консорциума W3C XML Schema.
Зачем использовать создание документов в формате, который устаревает?

Для начала нужно понимать что такое XML, DITA, DTD и схема.
DITA - это стандартизованная комитетом OASIS XML технология, все активнее поддерживаемая индустрией (CMS, редакторы и т.д.) и крупнийшими вендорами такими как Nokia, SUN, Cisco, IBM, Intel, Oracle, AT&T, Siemens, Huawei и т.д. (перечислил только телеком так как меня это интересовало).
Компания Content Technologies совместно с Microsoft ведет разработку продукта DITA Exchange (http://www.dita-exchange.com), который строится на базе Microsoft Office SharePoint Server 2007 (MOSS). Недавно реализована интеграция с Word2007.
Дата рождения DITA 1999 (в IBM), перешла в OASIS (т.е. стала стандартом в 2004). Что тут устаревает?

Что касается DTD и схем, то это просто описания элементов (к примеру DITA или DocBook или вобще свой формат), их атрибутов, и местоположения в структуре. DTD идет со времен SGML, а схемы придумали как альтернативу (в XML формате).
И DTD и схема (коих кстати тоже много бывает) есть для DITA - что нравится то и бери - другое дело что пока не перешли на схемы, а DTD считается устаревающим форматом.
 
Цитата

И DTD [b:ytcc0pf5]и схема[/b:ytcc0pf5] (коих кстати тоже много бывает) есть для DITA - что нравится то и бери - другое дело что пока не перешли на схемы.
Вот этого я и не знала...
 
Цитата

Что касается DTD и схем, то это просто описания элементов (к примеру DITA или DocBook или вобще свой формат), их атрибутов, и местоположения в структуре. DTD идет со времен SGML, а схемы придумали как альтернативу (в XML формате).
И DTD и схема (коих кстати тоже много бывает) есть для DITA - что нравится то и бери - другое дело что пока не перешли на схемы.
Цитата
Что касается DTD и схем, то это просто описания элементов
Каких элементов? Страниц? Глав? или это типа XSL-шаблонов, грубо говоря разметка страницы?
И можно дать более подробное описание что такое[b:1lz268hg] DTD[/b:1lz268hg] и [b:1lz268hg]схема[/b:1lz268hg].
Быть или не быть?
 
DTD это понятие языков разметки - SGML, HTML, XML. В XML для преодоления ограничений присущих DTD (например типы) ввели еще и схемы.  Это не понятия которые появились в DITA или DocBook. Почитайте любую книгу по XML  и все станет понятно.
Если кратко то DTD и Схема это просто описание словаря элементов, их атрибутов, и отношения между собой. Элементы - это теги, которыми размечается документ. Например элементы HTML: <head>, <body>, <p>, <title> и т.д. В DITA стремились использовать теже элементы что и в HTML. В DocBook названия у элементов несколько другие например <para>, <chapter1> и т.д.

У большинства элементов есть атрибуты. Например у элемента <img> есть этрибут src.

Можно воспринимать элементы как существительные, а атрибуты как прилагательные.

Помимо этого в DTD и схеме задаются ограничения того как элементы могут составлять структуру. Например можно задать что элемент <p> может содержать елеемент <img>, но не наоборот.
 
XML я немного знаю, а HTML как говорится от и до. Т.е просто размечаешь весь текст как в вебе, но тут возникает вопрос, а удобно ли писать так? Не теряется ли "литературная" часть текста?
Быть или не быть?
 
Трудно говорить об удобстве. Думаю поначалу неудобно - нужно привыкнуть к XML-редактору. Вообще зависит от редактора. В блокноте думаю будет неудобно. В принципе когда в ворде пишешь, то делаешь оформительскую разметку (стили форматирования), а когда в DocBook и DITA делаеш смысловую разметку с помощью элементов (тегов). Все форматирование (шрифты, колонтитулы, отбивки и т.д.) задано в XSLT и применяется на этапе сборки в выходной формат - pdf, xhtml.
 
[b:1x5dgpxf]Еще несколько ссылок на материалы о технологии DITA на русском языке:[/b:1x5dgpxf]

DITA (материал из Википедии) - http://ru.wikipedia.org/wiki/DITA
Корьевкина М. Технология DITA: обзор возможностей и основные преимущества - http://www.philosoft.ru/dita-intro.zhtml
Darwin Information Typing Architecture на lib.custis.ru - http://lib.custis.ru/index.php?title=Da ... anmonobook
Документы XML многократного использования - http://www.pcwork.ru/dokumentyi_xml_mno ... vaniya.htm
Как работать с XML - http://www.syntext.ru/xml-resources/wha ... -with-xml/
Сиверсон Э. Как работает компонентный авторинг - http://stevanivan.igp.ru/htdocs/2013-07 ... Tools.html
Подготовка технической документации с использованием asciidoc и DocBook - http://iportnov.ru/en/blog/2011/03/19/p ... -i-docbook
Если у вас появятся вопросы, пожалуйста, обращайтесь - будем думать вместе!
 
Цитата
Еще несколько ссылок на материалы о технологии DITA на русском языке:
Ссылки каждый может сам нагуглить, а вот описать технологию и помочь кому-то в её начинаниях - это интереснее. Для этого люди и обращаются на форум.

Цитата
А почему бы не сделать здесь? Я могу сделать отдельный раздел под это дело, если Вам это будет интересно.

Один настойчиво предлагает собирать информацию здесь, другой настойчиво отправляет коллег на другие сайты. Непонимаю  :idea:  8)
 
Цитата

Зачем делать массу ссылок на другие источники, если можно собрать все в одном?

А разве есть все в одном месте на русском языке? Я не нашел.
Надеюсь, что когда-то в этом разделе все будет.
Тогда другие ссылки будут не нужны.  :)
Пока я постарался выделить наиболее содержательные ссылки, которые удалось найти. Очень ждем вашего перевода.
Если у вас появятся вопросы, пожалуйста, обращайтесь - будем думать вместе!
 
Цитата
В указанных Вами разделах все очень хорошо. Однако все они построены по принципу "Вопрос-ответ": одни люди задают вопросы, а другие - по возможности, отвечают на них.
Может быть можно в каждом из указанных Вами разделов есть смысл создать подразделы, где желающие могли бы делиться с начинающими техническими писателями своим опытом решения сложных или интересных проблем при использовании того или иного ПО?

Цитата
А разве есть все в одном месте на русском языке? Я не нашел.
_________________
Если у вас появятся вопросы, я буду рад вам помочь.

А зачем тогда подпись такую ставить?
Практически на все вопросы по Dita на этом форуме были даны ответы. Нет вопросов - нет ответов. Разве кто-то спрашивал про ссылки? Просто так переадресовывать на другие ресурсы, просто не патриотично по отношению к [u:1p588ysy]этому[/u:1p588ysy] форуму.
 
Цитата
Надеюсь, что когда-то на этой ветке все будет.
Тогда другие ссылки будут не нужны.
Но к этой ветке уже никто не обратится, т.к. есть информация на других форумах.

Кстати, на http://ru.wikipedia.org/wiki/DITA есть ссылка на techwriters.ru/forum, т.к. он является "всемирным" нейтральным ресурсом. Остальные - конкуренты  :lol:
 
Цитата
Цитата
А разве есть все в одном месте на русском языке? Я не нашел.
_________________
Если у вас появятся вопросы, я буду рад вам помочь.

А зачем тогда подпись такую ставить? Практически на все вопросы по Dita на этом форуме были даны ответы. Нет вопросов - нет ответов. Разве кто-то спрашивал про ссылки? Просто так переадресовывать на другие ресурсы, просто не патриотично по отношению к [u:3b7c4wrh]этому[/u:3b7c4wrh] форуму.

Приношу свои извинения, уважаемый [b:3b7c4wrh]ADVANCED[/b:3b7c4wrh]. Хотел сделать как лучше, в просветительских целях... :)
Подпись здесь на форуме универсальная, она не относится специально к данному сообщению. Иногда, действительно, получается не к месту. Может быть изменю или уберу ее.
Насчет "непатриотзма" - не думал. Но в разделе [b:3b7c4wrh]Word[/b:3b7c4wrh], например, действует обучающий подраздел, для начинающих технических писателей. Там, естественно, приходится давать ссылки на другие сайты, так как на данном сайте нет возможности все поместить (и, часто, не имеем права). На ссылку же мы имеем такое право.
При консультировании также часто приходится давать ссылку на страницы, где вопросы, интересующие пользователя, разобраны более подробно. Не всегда удобно дублировать то, что уже имеется на просторах интернета.
Ссылку в Википедии на этот форум видел - меня это порадовало.
Мне кажется, что было бы очень полезно и здесь сделать обучающий подраздел. Я был бы его постоянным читателем.
Если у вас появятся вопросы, пожалуйста, обращайтесь - будем думать вместе!
 
Цитата
Но в разделе [b:2dr4e6cj]Word[/b:2dr4e6cj], например, действует обучающий подраздел, для начинающих технических писателей. Там, естественно, приходится давать ссылки на другие сайты, так как на данном сайте нет возможности все поместить (и, часто, не имеем права). На ссылку же мы имеем такое право.
При консультировании также часто приходится давать ссылку на страницы, где вопросы, интересующие пользователя, разобраны более подробно. Не всегда удобно дублировать то, что уже имеется на просторах интернета.
ОК. :P
С вордом понятно. Это наиболее популярный инструмент не только у писателей, ссылаться на сайт Microsoft или специализирующиеся на обучении сайты вполне нормально. А что касается  Dita как инструмента (Dita Open Toolkit), пока никто нигде не привел ничего конкретного про ввод в действие и настройку. Везде только теория и введение, а это и есть дублирование информации.
Буду рад ответить на вопросы связанные с работой Dita и помочь в её внедрении в организациях.
Страницы: 1 2 След.
Читают тему