Formatação esquema XSD para revisão por pares

Question

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 WSDL.

Eu gostaria de enviar o esquema XSD ao redor e perguntar as pessoas envolvidas para revisão por pares do modelo de dados.

Que ferramenta ou apresentação método que você sugeriria para ser usado como base para análises pelos pares? O modelo de dados deve ser legível para as pessoas não-qualificados, pelo menos quando se trata dos significados semânticos dos parâmetros

Editar:

Para ser mais específico: Claro, sintaticamente, os valida esquema. Na verdade, eu já estou trabalhando no código que é baseado em classes JAXB geradas. Meu objetivo é

1. para congelar o modelo de dados e, assim, os parâmetros de entrada
2. para se certificar nada se perdeu ou esqueceu de uma semântica (no sentido de ponto de vista de negócios relevantes).

Editar 2

Eu estive pensando sobre como seria provavelmente melhor para espalhar uma datamodel redor. Estou pensando em algo como um JavaDoc para esquemas XSD. Alguém sabe se algo como o que existe? Basicamente, seria feito com um conjunto de XSLTs, certo?

Answer 1

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

• xs3p
  • folha de estilo XSLT que gera único XHTML de XSD
• xsddoc
  • livre / LGPL
  • principalmente XSLT com base
  • JavaDoc como saída
  • exemplos xsddoc
• xnsdoc
  • melhorou versão comercial do xsddoc
  • gratuito para uso pessoal / educacional
  • JavaDoc como saída
• XSDdoc 2,0
  • comercial
  • JavaDoc como saída

Para esquema de XML pequena, eu provavelmente iria sugerir o uso do xs3p folha de estilo XSLT. Para mais um esquema complexo, eu sugiro usar xsddoc .

Answer 2

Eu recomendo usando o XSD para alguma coisa. Especificamente, mostrar algumas aplicações reais, com exemplos como o código real.

aplicações reais são o que fazem um interessante esquema. Os exemplos não tem que ser grande, sofisticado ou completamente realista. Eles só têm de compilar. Outras pessoas vão querer copiar e colar os exemplos de código.

Esses exemplos são a "Olá mundo" do esquema. E agem como uma espécie de teste de unidade para o esquema.

Answer 3

A coisa mais próxima de Javadoc para um esquema XML que eu vi está executando a ferramenta Javadoc na fonte gerado a partir do esquema. Isso requer duas coisas:. 1) que o esquema tem elementos de anotação internos que documentam, e que 2) o seu gerador de origem usa essas anotações como elementos Javadoc

Answer 4

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

Eu vou experimentá-lo agora, precisam de uma maneira simples para gerar um documento com todos os tipos e xsd disponíveis: Descrição documentação como uma descrição interface simples ...

Answer 5

** Divulgação: Eu trabalho para Innovasys, o produtor do instrumento de documentação mencionados abaixo *

Você poderia dar uma olhada Innovasys Documento! X . Bem como gerar automaticamente uma página estruturado e ligado para cada elemento, tipo simples, tipo complexo, e grupo atributo que também irá gerar diagramas XSD ligadas (incluindo sequências / escolha etc.) e tabelas de estruturas que incluem as anotações dos seus XSDs e fazer sentido das relações entre os elementos em seus esquemas. A saída é modelo baseado assim que você pode adaptá-lo ao seu estilo e estrutura preferida. Ele vai construir saída para web html pronto ou arquivos de ajuda compilados.

Uniquely ele também inclui um editor WYSIWYG que permite criar conteúdo adicional para complementar o material que é gerado automaticamente e as anotações da fonte XSD - assim você pode fornecer informações contextuais para sua revisão por pares. Há também uma característica Comunidade extensões que permite às pessoas ver a saída gerada a comentários recordes e feedback e que podem ser vistos e acionadas diretamente de dentro do documento! X.