Comment documenter un schéma XML?

J'ai développé un schéma XML pour une application que j'ai écrite. Maintenant, je veux documenter la structure valide pour l'utilisateur final, mais je ne peux pas trouver un moyen naturel de le faire. J'ai vu des choses comme xs3p, qui convertit essentiellement un schéma xsd en une représentation HTML, mais cela ne me semble pas une bonne documentation; l'utilisateur ne devrait pas avoir besoin de savoir quoi que ce soit sur les schémas pour comprendre ce qu'il est autorisé à faire.Comment documenter un schéma XML?

Des idées pour documenter cela? Des programmes/éditeurs/solutions graphiques ou simplement des concepts sur lesquels je peux me baser?

Source

2010-12-31 lucas clemente

La meilleure façon (après 6 ans d'expérience avec XSD et système de conception/codage des interfaces du système) à mon avis, est d'utiliser le xsd: documentation et xsd: annotation qui sont conçus pour cela. De cette façon, le XSD est auto-documenté (un peu comme le document java que vous avez dans le code source) et la documentation est toujours distribuée avec le XSD. Regardez l'exemple de here et comment la documentation est affichée sur place dans un éditeur XML. alt text

Si vous ne veut pas le faire alors je vous suggère de regarder ce post How to convert xsd to human readable documentation?

Source

2010-12-31 21:30:36

ce qui est l'éditeur que vous avez utilisé ici? –

Oxygen XML Editor. Bon marché et meilleur. J'avais l'habitude d'utiliser XmlSpy plus tôt que je déteste. –

Comment documenter un schéma XML?

Répondre

Questions connexes