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

Question

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

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

Answer 1

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

Если вы не хотите, чтобы сделать это, то я предлагаю вам взглянуть на этот пост How to convert xsd to human readable documentation?