Как работать с XML

Чтобы организовать разработку документации в формате XML, можно обратиться за консультацией или за готовым решением. Или же вы можете организовать все самостоятельно - следующие шаги описывают данный процесс.

Выберите формат XML

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

DITA - Архитектура типизированной информации Darwin

DITA призывает писать контент в виде отдельных маленьких самодостаточных модулярных фрагментов (топиков). Топики образуют единый источник и могут быть многократно использованы для различных конечных документов. Данный подход, ориентированный на топики, акцентирует модулярность и повторное использование топиков как четких и компактных единиц информации. Такой подход противопоставляется написанию длинных книгоподобных документов, таких как XML документы в формате Docbook.

Docbook

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

Или создайте свой собственный формат

Несмотря на широкий выбор доступных форматов XML, вам, возможно, необходимо создать свой собственный внутренний тип XML документа.

Задайте структуру

XML позволяет вам определить собственную структуру XML документа со списком разрешенных элементов и атрибутов. Это может быть сделано с помощью Схемы XML или DTD.

Разработайте оформление

Информация о том, как отображать контент, задается не в самом документе XML, а в отдельных таблицах стилей CSS или XSLT, либо с помощью JavaScript.

Решите, где будут храниться ваши документы

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

Файловая система

Файловые системы - это базы данных, используемые для хранения и организации документов.Они могут быть разных типов (дисковая/флэш/сетевая) и предлагают полезные функциональные возможности, такие как регистрация событий и управление версиями.

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

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

Найдите подходящий инструмент для написания документации

Для работы с документами XML , вам понадобится XML редактор. Не стоит путать XML редактор со средой разработки XML, которая используется для написания кода, например, таблиц стилей XSL или Схем XML.

XML редакторы бывают разных видов: текстовые, графические, визуальные. XML редактор Serna Enterprise и бесплатный XML редактор Serna Free - визуальные, со встроенной поддержкой популярных типов документов, включая DITA, Docbook и TEI, а также с возможностью для пользователей работать с собственными форматами XML документов.