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

Question

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

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

Answer 1

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

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