Organization of Examples document

[Patrick Durusau <patrick@durusau.net>]

Greetings!

One thing that I thought about while at lunch was a different way to 
organize the examples document.

If we start with a scenario, which obviously proceeds from the user's 
viewpoint, then why not organize the rest of the examples the same way?

Say for example we have a legal document and the scenario says it is an 
intake form that has the client's name, address, spouse, type of 
business, and that it is a bankruptcy form, which includes who they owe 
money too (important for conflict of interest if the firm represents a 
particular lender), etc.

If that is the starting point, then shouldn't we start with the document 
to which the metadata will be added? (Noting that we should not present 
in content metadata and metadata linked with xml:id as back to back 
alternates for a single example. That gets too confusing. Limit each 
example to *one* way to do the metadata. If we want to show both ways, 
restart or use another example).

After showing the in content or other way to link in the metadata, then 
show the RDF/XML file that has the metadata. (briefly)

Then, as the final step and the one most removed from the scenaro, do 
the metadata manifest.

Note that as we move away from the scenario the process becomes more 
abstract, just as does the level of markup we are dealing with.

If the examples are brief enough, implementors who are concerned with 
the metadata manifest details should not be overly delayed in getting to 
those details. But, it will also be easy for the average person 
evaluating what can be done with the metadata in ODF to get a quick 
grasp of how it is actually applied.

 From an explanation standpoint I think that will work better than our 
present arrangement.

Comments/suggesions?

Hope everyone is having a great day!

Patrick

-- 
Patrick Durusau
Patrick@Durusau.net
Chair, V1 - Text Processing: Office and Publishing Systems Interface
Co-Editor, ISO 13250, Topic Maps -- Reference Model
Member, Text Encoding Initiative Board of Directors, 2003-2005

Topic Maps: Human, not artificial, intelligence at work!