About the project detailed description
← Older revision
Revision as of 19:25, 15 March 2014
Line 23:
Line 23:
:Social Help
:Social Help
*''Describe your project in 10-20 sentences. What are you making? Who are you making it for, and why do they need it? What technologies (programming languages, etc.) will you be using?''
*''Describe your project in 10-20 sentences. What are you making? Who are you making it for, and why do they need it? What technologies (programming languages, etc.) will you be using?''
−
:Social Help is
going to be
a system wide mechanism to access a range of social channels like IRC
and
forums.
In order to access
a context
-dependent window with
available
communication channels, the user should press
<Shift><Alt><c>
(c stands for chat or connect). The user can choose between being connected
to IRC
(via IRC activity)
or
post a question
to
a forum (Discourse, Moot or some other reasonable modern forum software)
.
+
====Abstract====
+
:Social Help is a system wide mechanism to access a range of social channels like IRC
,
forums
or social networks (i
.
e. Sugar Network) within
a
specific
context
. Basic implementation is
available
on [https://github.com/ana-balica/sugar/tree/prototype-social-help github branch prototype-social-help]. The prototype includes a system-wide handling of a keypress combination -
<Shift><Alt><c>
, which pops up a window that has 2 options:
to
join
IRC or to
open the Browse activity
.
At the moment the following window looks like that:
−
:The
feature
is oriented towards users of Sugar (kids) that for various reasons are in need of social interaction:
+
<gallery>
+
screenshot_sugar1.png|Social Help window within Read Activity
+
screenshot_sugar2.png|Social Sugar window within TurtleArt activity
+
</gallery>
+
+
:
Here is a simple UI design of the window (made in Inkscape).
The
Discourse button is merely an example (in case the community decides on using a different forum platform).
+
+
<gallery>
+
Social_help_window.png|Social Help window design
+
</gallery>
+
+
====Functional requirements====
+
{| class="wikitable" style="margin: 1em auto 1em auto;"
+
|-
+
! Nr !! Description !! Priority !! Time to implement !! Comments
+
|-
+
| 1 || On a specific keypress bring up a window with a list of available social channels for the specific context || Major || 4 days ||
+
|-
+
| 2 || Create a toolbar button in the sugar toolkit with a palette that contains all available social channels for the following activity || Major || 4 days || The priority is set to major, since a visual component to access Social Help is more intuitive and simple to find.
+
|-
+
| 3 || Include Social Help toolbar button to the main activities included in the standard distribution || Major || 1 day || If the button won't be made available from the UI, the whole reason to have it disappears.
+
|-
+
| 4 || On clicking the IRC button, IRC activity should be opened with the name of the user set from system settings and the respective channel joined. || Major || 3 days || In my opinion an IRC channel option should be present along with the forum possibility, because it is the fastest and most straight-forward way to get a quick answer to a short, well-formed question (nevertheless it contains its drawbacks, which are surely covered by forum style help). I am also wondering if there is going to exist a single or multiple help channels.
+
|-
+
| 5 || Display an error message in case the user has chosen to ask for help via IRC activity and the following activity is not installed. Propose to open the browser to the download page of the IRC activity. || Medium || 2 days ||
+
|-
+
| 6 || On clicking the forum button, resume the Browse activity and open an extra tab that links to the forum address. || Major || 3 days ||
+
|-
+
| 7 || Create an automatic way of registration/authentication to afford users to post questions on the forum/network as quick as possible. The registration and authentication progress is dependent on the platform to be chosen. || Medium || 2 weeks || It is quite important to create a flawless workflow to the user, it is especially important in case it is going to be a one time access. If a user will visit the forum/network more than once, than the browser clearly keeps the session data and allow instant access to posting.
+
|-
+
| 8 || Localize all the components of Social Help || Major || 2 days ||
+
|-
+
| 9 || Create the Code of Conduct for Social Help channels || Minor || 3 days ||
+
|}
+
+
====Conclusion====
+
:Social Help
is oriented towards users of Sugar (kids) that for various reasons are in need of social interaction:
:* ask a question on how to achieve something within Sugar or an activity
:* ask a question on how to achieve something within Sugar or an activity
:* share knowledge and experience
:* share knowledge and experience
Line 57:
Line 94:
:Additionally I was employed as software developer for 8 months at [http://www.red-sky.com/ Red Sky] (had to quit due to change of geolocation). I have worked on [http://www.carocean.co.uk/ CarOcean] project, which is based on Scrapy framework. My responsibility was to handle about 100 different spiders (the project is available in 9 countries). Consequently I got a lot of experience in crawling the web, using xpath, regular expressions, agile methodology. As well I have worked on small PHP (Zend framework) projects.
:Additionally I was employed as software developer for 8 months at [http://www.red-sky.com/ Red Sky] (had to quit due to change of geolocation). I have worked on [http://www.carocean.co.uk/ CarOcean] project, which is based on Scrapy framework. My responsibility was to handle about 100 different spiders (the project is available in 9 countries). Consequently I got a lot of experience in crawling the web, using xpath, regular expressions, agile methodology. As well I have worked on small PHP (Zend framework) projects.
+
+
===Project prototype===
+
+
The prototype is hosted on github - https://github.com/ana-balica/sugar/tree/prototype-social-help
+
+
+
+
Functional requirements:
===You and the community===
===You and the community===