RE: UCR doc skeleton

Hi Phil,
I think I need a guideline:
- I had a look at the Data Shapes WG  https://www.w3.org/2014/data-shapes/wiki/Main_Page : from there they link a W3C site UC page https://www.w3.org/TR/shacl-ucr/ and the UCR page on Github as Editor's Draft - http://w3c.github.io/data-shapes/data-shapes-ucr/ 
- Q1: what is the relationship between the W3C site page https://www.w3.org/2016/poe/wiki/Use_Cases and the Github page [2]
- Q2: How to edit the UCR page 1: how to split the work between my editing and the ReSpec library?
- Q3: How to edit the UCR page 2: how to trigger the work of the ReSpec library? (or is this implicitly triggered by some event?)
- Q4: do I get it right that the Use Cases and the Requirements should be on a single page?

Note: I've set up a local POE Git repository and edited a single character in the UCR index.html page - was not able to push it to the W3C Github POE respository. Is this approach wrong or do I only need rights for that action? (I see only you and Ivan are currently collaborators.)

For me most essential is Q1 as currently I don't understand i/ why to have very similar pages and ii/if there is a chance to update/synchronize data from one page to the other one.

Best,
Michael


-----Original Message-----
From: Phil Archer [mailto:phila@w3.org] 
Sent: Thursday, April 14, 2016 1:55 PM
To: Michael Steidl (IPTC) <mdirector@iptc.org>
Cc: W3C POE WG <public-poe-wg@w3.org>
Subject: UCR doc skeleton

Michael - and anyone else who might be an editor of our docs at a later stage.

As use cases are now coming in, you may or may not want to start working on the actual UCR doc. To help kick things off, I have created a skeleton doc in the GitHub repository [1] that can be seen as it appears to a normal person [2].

The donkey work is done by the ReSpec library. This handles the version IDs, author links and W3C boiler plate. Editors just need to write the content.

If you prefer to use a WYSIWYG editor, http://www.bluegriffon.org/ seems to be the tool of choice for many editors. There are 101 rules about how we write these docs (ids on every section, write in simplified (US) English, etc.) but we can cover those over time (perhaps with a separate call for editors so I can walk you through some of it). The main thing is make a start :-)

HTH

Phil.

[1] https://github.com/w3c/poe
[2] http://w3c.github.io/poe/ucr/


-- 


Phil Archer
W3C Data Activity Lead
http://www.w3.org/2013/data/

http://philarcher.org
+44 (0)7887 767755
@philarcher1

Received on Thursday, 14 April 2016 16:03:45 UTC