W3C home > Mailing lists > Public > public-dxwg-wg@w3.org > June 2018

Re: [dxwg] Profile Composition and Languages

From: kcoyle via GitHub <sysbot+gh@w3.org>
Date: Thu, 28 Jun 2018 15:44:41 +0000
To: public-dxwg-wg@w3.org
Message-ID: <issue_comment.created-401080392-1530200680-sysbot+gh@w3.org>
@nicholascar I was hoping to find an example of what I mean by basic documentation, but I didn't find something analogous in a very short search. Just looking at a bunch of readme's kind of sets the stage. What I imagine is really quite simple, which is adding some paragraphs to the readme or a short introduction of profileDesc that says:

- What is the problem that it addresses
- How (high level) does it solve it?
- Who is it for? (e.g. developers of ... )
- Where does it fit into a work flow? (e.g. how does one use it?)
- then maybe one of the high level diagrams with a sentence describing each _thing_ and anything else that you think people should know to understand the diagram

I'm thinking this ends up being a screen or screen and half of stuff. Kind of an "elevator talk" level that promotes the idea. Then we'll ask folks to read it and they may have questions or suggestions. 

BTW if this already exists in another file then I missed it while poking around and I apologize, so let's make it more visible.

-- 
GitHub Notification of comment by kcoyle
Please view or discuss this issue at https://github.com/w3c/dxwg/issues/162#issuecomment-401080392 using your GitHub account
Received on Thursday, 28 June 2018 15:44:44 UTC

This archive was generated by hypermail 2.3.1 : Wednesday, 30 October 2019 00:15:44 UTC