search

HydraCG / Specifications

Specifications created by the Hydra W3C Community Group
Other
139 stars 25 forks source link

Improve vocabulary illustration #24

Open lanthaler opened 10 years ago

lanthaler commented 10 years ago

_This was raised by László Lajos Jánszky:_

The illustration contains an arrow which is maybe an error its source is the Operation, its target is the Resource.operations and its type is rdfs:subClassOf. I don't think that the Operation class is a subClass of Resource.operations which is a property. Maybe I am wrong with this...

The 2 type of arrows on the illustration are too similar. I think you should have created an UML class diagram instead of your custom diagram type. It would be easy understandable for everyone. There are great tools to create such diagrams...

akuckartz commented 10 years ago

My main problem with this illustration is that the semantics of the horizontal and vertical axis is not obvious (if there is any :-).

lanthaler commented 10 years ago

What exactly do you mean by "horizontal and vertical axis”?

akuckartz commented 10 years ago

@lanthaler It is not obvious why an entity is shown to the left or right or above or below another entity in the graphic. For example: some superclasses are above and some are shown below a subclass. And some superclasses are to the left while others are to the right of a subclass.

lanthaler commented 10 years ago

Oh OK, I see. The position is arbitrary.. it doesn’t have any meaning. Is there any notation where it has?

akuckartz commented 10 years ago

@lanthaler Just use one main direction: left to right or top to bottom to position the entities.

A further suggestion: move Collection and PagedCollection to a separate illustration if they are not linked to the rest.

lanthaler commented 10 years ago

_Proposal by @jindrichmynarz:_

How about improving it by having 2 diagrams:

  • Higher-level (really "at a glance") diagram depicting the main classes that correspond to the (new) structure of the Hydra specification.
  • Detailed diagram (like the current one) depicting the (almost) complete Hydra vocabulary.
lanthaler commented 9 years ago

_Chris Chapman wrote:_

+1. It seems like the spec is forming into fairly discrete components(?), and it may be good to have a diagram per component. At first, start with the basic building blocks, and then give the "big picture" at the end.

lanthaler commented 9 years ago

_Martijn Faassen wrote:_

I think it would make more sense and be less intimidating if the figure was in an appendix. You can say "if you're already familiar with RDF and vocabularies, please check the appendix for a picture giving an overview", or something.