Formatando esquema XSD para revisão por pares

Eu projetei um modelo de dados que é representado por um esquema XSD. O modelo de dados também fornece os tipos que estão sendo usados ​​como parâmetros de serviço da web em um descritor de WSDL.

Eu gostaria de enviar o esquema XSD e pedir às pessoas envolvidas que revisem o modelo de dados.

Que ferramenta ou método de apresentação você sugeriria para ser usado como base para revisões por pares? O modelo de dados deve ser legível para pessoas não qualificadas, pelo menos quando se trata dos significados semânticos dos parâmetros

Editar:

Para ser mais específico: claro, sintaticamente, o esquema valida. Na verdade, eu já estou trabalhando em código que é baseado em classes geradas pelo JAXB. Minha meta é

  1. para congelar o modelo de dados e, assim, os parâmetros de entrada
  2. para se certificar nada se perdeu ou foi esquecido de um semântico (no sentido de ponto de vista relevante para os negócios.

Editar 2

Eu estive pensando sobre como provavelmente seria melhor espalhar um datamodel por aí. Estou pensando em algo como um JavaDoc para esquemas XSD. Alguém sabe se algo assim existe? Basicamente, isso seria feito com um conjunto de XSLTs, certo?

10
adicionado o autor f3lix, fonte

5 Respostas

Eu conheço as seguintes ferramentas que geram documentação de arquivos xml Schema (XSD):

  • xs3p
    • XSLT stylesheet that generates single XHTML from XSD
  • xsddoc
  • xnsdoc
    • improved commercial version of xsddoc
    • free for personal/educational use
    • JavaDoc like output
  • XSDdoc 2.0
    • commercial
    • JavaDoc like output

Para um esquema xml pequeno, provavelmente sugeriria usar a folha de estilo XSLT xs3p . Para mais um esquema complexo, sugiro usar o xsddoc .

20
adicionado

A coisa mais próxima do Javadoc para um esquema xml que vi foi executar a ferramenta Javadoc na origem gerada a partir do esquema. Isso requer duas coisas: 1) Que seu esquema tem elementos de anotação interna documentando-o e que 2) seu gerador de origem usa essas anotações como elementos Javadoc.

0
adicionado

Eu recomendo usar o XSD para algo. Especificamente, mostre alguns aplicativos reais, com exemplos como código real.

Aplicações reais são o que tornam um esquema interessante. Os exemplos não precisam ser grandes, sofisticados ou completamente realistas. Eles só precisam compilar. Outras pessoas vão querer copiar e colar as amostras de código.

Esses exemplos são o "hello world" do esquema. E eles agem como uma espécie de teste unitário para o esquema.

0
adicionado

** Disclosure : I work for Innovasys, the producer of the documentation tool mentioned below *

Você pode dar uma olhada no Documento da Innovasys! X . Além de gerar automaticamente uma página estruturada e vinculada para cada elemento, tipo simples, tipo complexo, grupo e grupo de atributos, ele também gerará diagramas XSD vinculados (incluindo sequências/escolha etc.) e tabelas de estrutura que incluem as anotações de seus XSDs e faça sentido dos relacionamentos entre os elementos em seus esquemas. A saída é baseada em modelo para que você possa adaptá-la ao seu estilo e estrutura preferidos. Ele irá construir a saída para arquivos de ajuda html ou compilados na web.

Exclusivamente, ele também inclui um editor WYSIWYG que permite que você crie conteúdo adicional para complementar as coisas que são geradas automaticamente e as anotações da fonte XSD - para que você possa fornecer informações contextuais adicionais para sua revisão por pares. Há também um recurso de extensões de comunidade que permite que as pessoas que visualizam a saída gerada registrem comentários e feedback e que possam ser visualizadas e executadas diretamente a partir do documento! X.

0
adicionado

O muito útil desenvolvedor de Oxygen xml também suporta geração de documentação, veja http://www.oxygenxml.com/xml_schema_documentation.html (comercial, mas há um teste de 30 dias totalmente funcional disponível)

Vou testá-lo agora, preciso de uma maneira simples de gerar um documento com todos os tipos e o xsd disponível: descrição da documentação como uma descrição simples da interface ...

0
adicionado