I finally pieced together my thoughts on the Social API over the last couple of weeks, and yesterday it was accepted as an Editor's Draft for the W3C Social WG. Over the next month or so I'm hoping the group can work together to plug the gaps and reach consensus where there are various alternative ways of doing things so we can have a First Public Working Draft by our next face-to-face on the 1st of December.

🏷 cv decentralized editors draft phd resume social api social web socialwg specification standards w3c

Wed 21st of October 2015 at 10:08pm (+01:00)

API requirements derived from user stories

Draft post, in preparation for posting to SocialWG wiki

So far completed for approved user stories. ~~~~

Note: These requirements are deliberately limited by the contents of the user stories. If things seem obviously missing, this is because they were not referenced in the user stories. I've tried not to over-generalise when summarising them, too.

Process:

List required functionality from each user story.
Cluster related functionality, find overlap between stories (see colours/tags).
Organise requirements into shortlist.

Requirements shortlist

In no particular order. Tags/colours map to requirements by story, below.

sub Subscribe to content

According to some filter, eg. by a certain user, posted to a certain group.
Undo a subscription.

pub Publish content

Including text, photo, video, audio.
Including metadata and relations to other things, ie. audience/to, tags, reply-to, likes.
Update published content.
Delete published content.

notif Notifications

User is somehow alerted when content is created that explicitly targets them (ie. as recipient or subject).

read Read content

According to permissions.
Discovery of content according to criteria:
- type (text, photo..);
- associated with group;
- created by a particular user;
- by the content's target (replies/likes of a particular post).