题
我设计了一个数据模型,该模型代表的文件方案。模型数据也提供了类型被用来作为网络服务参数在WSDL的描述符。
我想发送文件的方案周围,并要求人民参与同行审查的数据模型。
什么样的工具或展示的方法将你的建议被用作一个基础,为同行评审?模型数据应该是可读的非技术人员,至少当涉及到的语义含义的参数
编辑:
更具体:当然,在句法上的,方案验证。实际上我已经是工作上的代码这是根据修订所产生的课程。我的目标是
- 冻结的数据模型以及这样 输入参数
- 要确保 什么都没有丢失或遗忘,从 语义(在的意义 商务有关)的观点。
编辑2
我一直在考虑它如何可能会是最好的传播datamodel周围。我想像如果是的话,为什么不试用一文件模式。任何人都知道,如果这样的东西存在?基本上,它将是完成一套Xslt,对吗?
其他提示
我建议使用 XSD。具体来说,显示一些实际应用程序,示例为实际代码。
实际应用程序使架构变得有趣。这些例子不一定要大,复杂或完全现实。他们只需要编译。其他人会想要复制和粘贴代码示例。
这些例子是“你好世界”。架构。它们可以作为模式的一种单元测试。
我见过的最接近Javadoc的XML模式是在从模式生成的源上运行Javadoc工具。这需要两件事:1)您的模式具有记录它的内部注释元素,并且2)您的源生成器将这些注释用作Javadoc元素。
非常有用的Oxygen XML开发人员还支持生成文档,请参阅 http://www.oxygenxml.com/xml_schema_documentation.html (商业,但有一个功能齐全的30天试用版)
我现在就试试看,需要一种简单的方法来生成一个包含所有类型和可用xsd的文档:文档描述作为一个简单的界面描述......
**披露:我为Innovasys工作,下面提到的文档工具的制作人 *
您可以查看 Innovasys Document! X 。除了为每个元素,简单类型,复杂类型,组和属性组自动生成结构化和链接页面之外,它还将生成链接的XSD图表(包括序列/选项等)和包含来自XSD的注释的结构表。了解模式中元素之间的关系。输出是基于模板的,因此您可以根据自己喜欢的样式和结构进行调整。它将构建输出到web就绪的html或编译的帮助文件。
独特地,它还包括一个WYSIWYG编辑器,允许您创作其他内容以补充自动生成的内容和来自XSD源的注释 - 因此您可以为同行评审提供其他上下文信息。还有一个社区扩展功能,允许人们查看生成的输出以记录评论和反馈,并且可以直接从文档中查看和操作! X.