[wsrp-wsia] [I#116] markup Interface should be the first described inthe spe c

[Gil Tayar <Gil.Tayar@webcollage.com>]

Status: Active

Topic: markup

Class: Editorial

Raised by: Gil Tayar

Title: markup Interface should be the first described in the spec

Date Added: 20-Oct-2002

Document Section: Interfaces/7

Description:

Today, the order of the sections describing the interfaces are: service description, registration, entity management, markup. This order comes from a life-cycle point of view. But note that only Markup is mandatory. Because markup is the only mandatory interface, I suggest that it be the first. I suggest this for three reasons:
1. It emphasizes the important thing...
2. ...thus making the spec easier to understand
3. It may reveal hidden dependencies between the interfaces which we might want to eliminate

 

Because markup uses other structures defined in other interfaces, it would also be a good excerise to define them first in terms of their use in markup. I would tend to think that this would simplify understanding their roles in the spec.

 

I also suggest keeping the order of the three others, or maybe moving registration to last (because there is an out-of-band mechanism).