Как задокументировать XML-схему?

Я разработал схему XML для написанного мной приложения. Теперь я хочу задокументировать действительную структуру для конечного пользователя, однако я не могу придумать какой-либо естественный способ сделать это. Я видел такие вещи, как xs3p, который по существу преобразует схему xsd в представление HTML, однако мне это не кажется хорошей документацией; пользователю не нужно ничего знать о схемах, чтобы понять, что ему разрешено делать.

Есть идеи, как это задокументировать? Какие-нибудь программы / редакторы / графические решения или просто концепции, на которых я могу опираться?


person lucas clemente    schedule 31.12.2010    source источник


Ответы (1)


На мой взгляд, лучший способ (после 6 лет опыта работы с xsd и проектирования / кодирования системы для системных интерфейсов) - использовать xsd: documentation и xsd: annotation, которые предназначен для этого. Таким образом, XSD самодокументируется (во многом как java-документ в исходном коде), а документация всегда распространяется вместе с XSD. Посмотрите пример из здесь и то, как документация представлена ​​в- поместите в редактор XML. alt text

Если вы не хотите этого делать, я предлагаю вам посмотреть этот пост Как преобразовать xsd в удобочитаемую документацию?

person Aravind Yarram    schedule 31.12.2010
comment
Редактор Oxygen XML. Дешево и лучше. Раньше я использовал XmlSpy, который ненавижу. - person Aravind Yarram; 01.01.2011