Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

v1,6,3 Adding documentation for XSD elements #17

Open
Asisyas opened this issue Feb 18, 2023 · 0 comments
Open

v1,6,3 Adding documentation for XSD elements #17

Asisyas opened this issue Feb 18, 2023 · 0 comments

Comments

@Asisyas
Copy link
Member

Asisyas commented Feb 18, 2023

<xs:schema elementFormDefault="qualified" targetNamespace="micro:dto-1.6" xmlns:xs="http://www.w3.org/2001/XMLSchema">

Problem description
Our application uses an XSD schema for validating input data. Many elements in the schema lack sufficient descriptions, making it difficult for our developers to understand and use the schema. Documentation needs to be added for all elements in the schema to provide clearer and more complete descriptions.

Steps to resolve

  • Analyze the current XSD schema and identify elements that lack sufficient descriptions.
  • Add xs:documentation annotations for each element that requires additional description.
  • Make changes to the build and documentation system to make these descriptions available to our developers and documenters.

Expected outcome
After adding documentation for XSD elements, our developers will be better able to understand and use the schema, leading to faster development and fewer errors.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

No branches or pull requests

1 participant