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

Add and maintain object diagrams for each feed #235

Closed
j-d-b opened this issue Jan 20, 2022 · 3 comments · Fixed by #330
Closed

Add and maintain object diagrams for each feed #235

j-d-b opened this issue Jan 20, 2022 · 3 comments · Fixed by #330
Assignees
Labels
Non-spec This issue is not related to the specification content

Comments

@j-d-b
Copy link
Collaborator

j-d-b commented Jan 20, 2022

Background

Prior to WZDx v4.0, the team maintained an object diagram (it is still in the repository) for the WZDxFeed. However, with the addition of two new feeds in WZDx v4.0, there were not enough team members with availability or knowledge of using the diagram software to create the object diagrams for the v4.0 feeds.

Proposal

Part of the issue was that the objects in the object diagram contained the full list of properties, so it was onerous to remove and add to them, especially if one was unfamiliar with the diagram software and text formatting.

I propose that we add and maintain object diagrams, but that the diagrams show just the objects and how they relate without showing the properties of each object. The user can get that information from the specification documentation. This would greatly decrease the amount of work to create the diagrams and there would be much less need for updates while still providing value.

@j-d-b j-d-b added the Non-spec This issue is not related to the specification content label Jan 20, 2022
@sergebeaudry
Copy link

Agreed. Was useful but I understand the pain and the information will be one click away with the proposal

@j-d-b
Copy link
Collaborator Author

j-d-b commented Aug 4, 2022

In addition, the high-level description of each object could be added, instead of listing all the properties.

@j-d-b j-d-b linked a pull request Aug 11, 2022 that will close this issue
@j-d-b
Copy link
Collaborator Author

j-d-b commented Sep 19, 2022

Implemented in #330.

@j-d-b j-d-b closed this as completed Sep 19, 2022
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Non-spec This issue is not related to the specification content
Projects
None yet
Development

Successfully merging a pull request may close this issue.

3 participants