W3C home > Mailing lists > Public > public-xg-socialweb@w3.org > May 2009

Template for editing user stories and XG deliverables

From: Karl Dubost <karl+w3c@la-grange.net>
Date: Thu, 21 May 2009 00:05:28 -0400
Message-Id: <D1B5F57D-8D07-4F72-98E2-F01DEBE4AF5B@la-grange.net>
To: public-xg-socialweb@w3.org
Hi XG,

This is to complete my action item
ACTION-11 [Produce a template for TF deliverables.][1]

In the past I have been using emails as a templating system, because  
it doesn't require too much time from the participants in terms of  
technologies (just text).

The goal of the template is to foster prototyping of deliverables by  
atomizing the input to regular patterns. Once we have collected enough  
[user stories][2], we can define large principles. It is still a bit  
early to do that.

Edit those on the wiki in the user stories section.

# USER STORIES TEMPLATE
========================================================
1. Do not make user stories too long. Only one or two
    sentences.  The patterns are usually:
      * As a [persona], he/she [does this].
      * When application [does X], user [does Y]

2. Try to categorize user stories by adding 2 or 3 tags
    behind your sentence (ex: #privacy #login). That
    should help us to categorize the user stories
    in big sections.
========================================================


 From the user stories, we will have identified social patterns. Ex:  
"Social networks login mechanisms". Before going to the next step we  
will have to collect a list of these patterns.

Usually technical specifications try to give answers to a certain  
number of issues so they can be solved by implementations. The goal of  
the XG is more about identifying the state of Art in the field and  
about identifying issues.

For the work on the deliverables, I propose you sent an email to public-xg-socialweb@w3.org 
  with the following template for each social identified social pattern.

For each social patterns, use this template:

# ATOMIC PATTERN DELIVERABLE TEMPLATE
========================================================
[Identified Social Pattern]

Facts: [quick paragraph 2/3 sentences]
        Make it as short as possible. It is a very quick
        description of the mechanism.
        Add a link to a resource describing the mechanism
        if it exists

Benefits: [one paragraph]
        What are the benefits? Think positive about it.
        Be simple in your terms choices.

Flaws: [one paragraph]
	What are the flaws of this mecanism?
         Here again be very factual, do not
	promote a technology over another.

Related: [list]
	Create a short list where this mechanism is
         used in a social network
========================================================


# QUICK TIPS

1. Writing a section should not take you more than 30 minutes for an  
[Identified Social Pattern]
2. Do not try to write correctly just let it flow.
3. Focus on short sentences.
4. Once finished, read it once and review
5. Give it to someone to read, collect comments and improve.
6. Write only *one* [Identified Social Pattern] a day.




[1]: http://www.w3.org/2005/Incubator/socialweb/track/actions/11
[2]: http://www.w3.org/2005/Incubator/socialweb/wiki/UserStories



-- 
Karl Dubost
Montréal, QC, Canada
http://twitter.com/karlpro
Received on Thursday, 21 May 2009 04:18:05 GMT

This archive was generated by hypermail 2.2.0+W3C-0.50 : Tuesday, 2 June 2009 18:35:30 GMT