Ongoing discussions within the SWIM communities of interest
Ongoing discussions within the SWIM communities of interest
Task outline
Review the Donlon TOBT Setting Service Description according to a series of viewpoints. Status = task is closed (23/4/19).
Viewpoints
Conformance
How far does the service description satisfy the requirements of the Service Description specification?
Possibly involve using the Conformance assessment report and the -Verification checklist for serv desc.
Good use of service
How far does the service description contain all information required by a service consumer to make good use of service?
Look at discoverability, assessment, client implementation.
Helpful example
Is this a good example? Is it helpful?
Is such an example for a fictitious service helpful as a Resource in the Supporting Material?
Basis for template
Does the structure of the example help?
Could it serve as the basis for a template?
(side question: Is an explicit separate template required?)
Review comments
5/3/19
please find attached a few comments for Donlon Example regarding the viewpoints.
Good use of a service
I think there should be some example code, how to use the service and an example response. There could also be a link to an external user interface.
More general: from a MET point of view, where can retrieved data formats (e.g. GRIB2) made be discoverable. Within Messages -> Datatype?
Helpful example
As for a starting point it would be helpful.
I think, maybe the sections should be grouped for a better readability. For instance group the sections for business experts and developers.
6/3/19
Assuming that the description is providing what the specification recommends, this is a good and understandable example.
The question remains, for what such an artefact could be used?
In my eyes, such a presentation is a Provider internal documentation (which of course could be given to the potentiell consumer) , which maybe is iterativly evolved during a process of Service design. To strive for SWIm compliance, a XML file still has to be generated out of such human readable Service Descriptions.
It could be considered to provide a teamplate for such human readable descriptions and a script to generat a SWIm Governance conform XML file out of it.
Processing of comments
Viewpoints
Conformance
- How far does the service description satisfy the requirements of the Service Description specification?
- Possibly involve using the Conformance assessment report and the -Verification checklist for serv desc.
- added: Conformance assessment - Donlon example; makes clear what is missing.
Good use of service
- How far does the service description contain all information required by a service consumer to make good use of service?
- Look at discoverability, assessment, client implementation.
- missing some (consumer) code example.
- This would probably mean to go for implementing the service
Helpful example
- Is this a good example? Is it helpful?
- Is such an example for a fictitious service helpful as a Resource in the Supporting Material?I
- reordering of section for better readability (eg business experts, developers)
- Any suggestion?
- In the mean time, the Table of Contents (see top right) makes it clear the structure and where to find info.
Basis for template
- Does the structure of the example help?
- Could it serve as the basis for a template?
- (side question: Is an explicit separate template required?)