Sugar Network/Concept: Difference between revisions
mNo edit summary |
No edit summary |
||
(2 intermediate revisions by one other user not shown) | |||
Line 3: | Line 3: | ||
== Overview == | == Overview == | ||
The | The major goal of the Sugar Network is to provide an infrastructure to let people share different types of content, e.g., Sugar Activities, artifacts created by Sugar Activities, books, etc. for friends, a class, parents, teachers, or Sugar Learners anywhere. | ||
Sugar Network's functionality is split into two parts: | |||
* | * Core functionality, which covers low level needs to work with content ([[#Summary|described below]]); | ||
* Any number of representation models for usage of content, which are based on core functionality and add high level scenarios to interact with the same content, e.g., gamification elements. Representation models are pluggable and optional. | |||
* | |||
== Targeted audience == | |||
{| border="0" | {| border="0" | ||
|- valign="top" align="let" | |- valign="top" align="let" | ||
| [[File:Sugar-network.png]] | | [[File:Sugar-network-audience.png|350px]] | ||
| | | The audience for Sugar Network is highly diverse: | ||
* | |||
* | * Students, which might be of different ages depending on a particular representation model or usage scenario; | ||
* | * Educators who need to populate content for students and review what students uploaded to the Network; | ||
* Deployment supporters who need to provide technical and educational support; | |||
* Software developers who will have a chance to get feedback directly from users. | |||
Any individual person might belong to several categories at the same time, e.g., be a content creator, a user of content created by different creators, a reviewer of content uploaded by another people, etc. | |||
|} | |} | ||
Line 34: | Line 38: | ||
== Needs == | == Needs == | ||
The needs that the Sugar Network is trying to support | The needs that the Sugar Network is trying to support might be described by the following selection of [[Wikipedia:Fundamental_human_needs|Fundamental human needs]]: | ||
'''Identity''' | '''Identity''' | ||
Line 95: | Line 99: | ||
=== Questions === | === Questions === | ||
General question about the Context. A user-friendly interface for asking questions about the current Context. The workflow is much simpler when compared to typical bug trackers (Trac, RT, etc.). It is intended to be more like "forums" or wiki "discussion" pages—just ask your question and wait for answers. In some cases, Questions might be treated as a kind of simple [[Wikipedia:Knowledge base|knowledge base]] for the Context (in contrast to bug trackers, Questions are not | General question about the Context. A user-friendly interface for asking questions about the current Context. The workflow is much simpler when compared to typical bug trackers (Trac, RT, etc.). It is intended to be more like "forums" or wiki "discussion" pages—just ask your question and wait for answers. In some cases, Questions might be treated as a kind of simple [[Wikipedia:Knowledge base|knowledge base]] for the Context (in contrast to bug trackers, Questions are not closed after answers are provided). The most useful Questions might be picked up to compose the [[Wikipedia:FAQ|FAQ]] for the Context. | ||
Other | Other non-developer needs are covered by [[#Ideas|Ideas]] and [[#Problems|Problems]]. Developer needs are covered by the [[#Objectives|Objectives]] and its advanced view, in particular. | ||
Actions: | Actions: | ||
Line 104: | Line 108: | ||
:* Discuss the Question; | :* Discuss the Question; | ||
:* Vote for the Question; | :* Vote for the Question; | ||
:* Create | :* Create an Answer; | ||
:* Discuss | :* Discuss an Answer; | ||
:* Vote for a single | :* Vote for a single Answer; | ||
:* Vote given by Question creator means an | :* Vote given by the Question creator means an Answer for the Question. | ||
=== Ideas === | === Ideas === | ||
Any ideas regarding the Context. A user-friendly interface to propose your idea to the current Context developers. The workflow is much simpler, compared to typical bug trackers | Any ideas regarding the Context. A user-friendly interface to propose your idea to the current Context developers. The workflow is much simpler, compared to typical bug trackers—just offer your suggestion, see how other people will rate it, and wait for an implementation. | ||
Actions: | Actions: | ||
Line 118: | Line 122: | ||
:* Discuss the Idea; | :* Discuss the Idea; | ||
:* Vote for the Idea; | :* Vote for the Idea; | ||
:* Create a Solution; | :* Create a Solution, a possible Implementation, Answer, or other Resource; | ||
:* Discuss a Solution; | :* Discuss a Solution; | ||
:* Vote for Solutions; | :* Vote for Solutions; | ||
:* Context team member | :* A Context team member designates one possible Solution to one Objective, the Idea's status becomes the same as the Objective's. | ||
=== Problems === | === Problems === | ||
Line 132: | Line 136: | ||
:* Discuss the Problem; | :* Discuss the Problem; | ||
:* Vote for the Problem; | :* Vote for the Problem; | ||
:* Create Solution; | :* Create Solution (proposed fix); | ||
:* Discuss a Solution; | :* Discuss a Solution; | ||
:* | :* Designate a Release as a possible Solution; | ||
:* Vote for a single Solution; | :* Vote for a single Solution; | ||
:* Vote given by Problem creator means a fix for the Problem. | :* Vote given by the Problem creator means a fix for the Problem. | ||
=== Wiki === | === Wiki === | ||
Line 152: | Line 156: | ||
:* Modify existing page; | :* Modify existing page; | ||
:* View the history of | :* View the history of modifications. | ||
=== Artifact === | === Artifact === | ||
A collection of binary objects, of types depending on Context type, associated the the Context. Such artifacts might be, for example, Journal objects created by Sugar | A collection of binary objects, of types depending on Context type, associated the the Context. Such artifacts might be, for example, Journal objects created by Sugar Activities. | ||
Actions: | Actions: | ||
Line 166: | Line 170: | ||
Todo: | Todo: | ||
:* Simplify creation of a new Exhibit by having a UI way to quickly share a newly created | :* Simplify creation of a new Exhibit by having a UI way to quickly share a newly created Activity object, e.g., from within the Naming alert or from the Journal. | ||
=== Implementation === | === Implementation === | ||
For software Contexts, this Resource is about released versions of this Context software. This is exactly what a User can execute. There might be several implementations with different stability levels. By default, Users execute only the most recent stable version | For software Contexts, this Resource is about released versions of this Context software. This is exactly what a User can execute in their instance of Sugar. There might be several implementations with different stability levels. By default, Users execute only the most recent stable version; but it is possible to choose any version. | ||
Actions: | Actions: | ||
Line 181: | Line 185: | ||
Todo: | Todo: | ||
:* Support Experiments workflow where people can make a copy of an existing Context and start experimenting with the code and use it on a regular basis, e.g., share | :* Support an ''Experiments'' workflow where people can make a copy of an existing Context and start experimenting with the code and use it on a regular basis, e.g., share it in the Sugar Network. | ||
:* | :* Provide a convenient method to attach log reports with errors to the particular Release, e.g., "Share the log" button on the Activity fail dialog. | ||
=== Objectives === | === Objectives === | ||
These are the exact objectives that a Context is trying to achieve. This type of | These are the exact objectives that a Context is trying to achieve. This type of Resource has two faces: | ||
* The view for Users that are not the | * The view for Users that are not in the role of Context implementer, who will see this Resource, e.g., as a set of features that the Context is trying to provide; | ||
* The fully functional project management interface for people who are owners of the Context and take care of its implementation. | * The fully functional project management interface for people who are owners of the Context and take care of its implementation. | ||
Actions: | Actions: | ||
:* Create by Context owners; | :* Create - by Context owners; | ||
:* Discuss the Objective; | :* Discuss the Objective; | ||
:* Vote for the Objective; | :* Vote for the Objective; | ||
Line 203: | Line 207: | ||
== Comments == | == Comments == | ||
All kinds of resources might be [[#Participation|commented on by any | All kinds of resources might be [[#Participation|commented on by any user]]. The Sugar Network does not provide any restrictions or permissions, the model is [[#Freedom|one of leaving responsibility to the viewer]]. | ||
== Events == | == Events == | ||
If some Resource has been changed, e.g., as a result of User interaction, the Resource sends out global notifications. The notification might be seen while investigating this particular object or by Following this Resource | If some Resource has been changed, e.g., as a result of User interaction, the Resource sends out global notifications. The notification might be seen while investigating this particular object or by Following this Resource, in which case, events will go to a followers' queue of global events. | ||
Events might be personal, e.g., personal invitations or personal messages. | Events might be personal, e.g., personal invitations or personal messages. | ||
Line 213: | Line 217: | ||
== Workflows == | == Workflows == | ||
These are | These are types of workflows that [[#Roles|Roles]] can take part in. The particular activity might involve several Users and several Roles. | ||
== Roles == | == Roles == | ||
Line 224: | Line 228: | ||
:* Go to Browser and click Home Context button; | :* Go to Browser and click Home Context button; | ||
:* Try to search if your problem was already reported using text search string or tags; | :* Try to search if your problem was already reported using text search string or tags; | ||
:* If search is not successful, describe your problem in Problem (as | :* If search is not successful, describe your problem in a Problem entry widget as fully as possible (same as for Questions and Ideas); | ||
:* The supporters will be notified and will reply with a request for further information, or with an answer; | :* The supporters will be notified and will reply with a request for further information, or with an answer; | ||
:* On the Network screen, you will be notified about a submitted reply. | :* On the Network screen, you will be notified about a submitted reply. | ||
Line 231: | Line 235: | ||
:* You need to be a part of a community with local support, thus, you will have a default place to complain, the Home Context; | :* You need to be a part of a community with local support, thus, you will have a default place to complain, the Home Context; | ||
:* Since | :* Since you have no any idea about what part of the system is affected, there is no way to decide against which Context to complain, go to Browser and click Home Context button; | ||
:* Try to search if your problem was already reported using a text search string or tags; | :* Try to search if your problem was already reported using a text search string or tags; | ||
:* If the search is not successful, describe your problem in a Problem entry widget (as for Questions and Ideas) | :* If the search is not successful, describe your problem in a Problem entry widget as fully as possible (as for Questions and Ideas); | ||
:* The supporters will be notified and will reply with a request for further information, or with an answer; | :* The supporters will be notified and will reply with a request for further information, or with an answer; | ||
:* On the Network screen, you will be notified about a submitted reply. | :* On the Network screen, you will be notified about a submitted reply. | ||
Line 241: | Line 245: | ||
:* Go to the Browser and try to find the Context that is associated with the problem part; use Tags and full text search; after finding it, click its Home button; | :* Go to the Browser and try to find the Context that is associated with the problem part; use Tags and full text search; after finding it, click its Home button; | ||
:* Search to see if your problem has already been reported using text search string or tags; | :* Search to see if your problem has already been reported using text search string or tags; | ||
:* If the search is not successful, describe your problem in Problem entry widget (as for Questions and Ideas) | :* If the search is not successful, describe your problem in Problem entry widget as fully as possible (as for Questions and Ideas); | ||
:* Any Context Contributor can reply with a request for further information, or with an answer; | :* Any Context Contributor can reply with a request for further information, or with an answer; | ||
:* On the Network screen, you will be notified about a submitted reply. | :* On the Network screen, you will be notified about a submitted reply. | ||
Line 251: | Line 255: | ||
:* Teachers/students can always get these materials by going to the Home Context and clicking Wiki. | :* Teachers/students can always get these materials by going to the Home Context and clicking Wiki. | ||
Suppose a Sugar | Suppose a Sugar Activity fails to start or fails on exit. | ||
:* The activity fail dialog should have a complaint field. Describe your problem there as fully as possible; | :* The activity fail dialog should have a complaint field. Describe your problem there as fully as possible; | ||
Line 273: | Line 277: | ||
:* The Journal should have a way to share any object with one click. | :* The Journal should have a way to share any object with one click. | ||
=== Sugar | === Sugar Activities === | ||
Fast launch of an | Fast launch of an Activity. | ||
:* Go to the Browser and explore the | :* Go to the Browser and explore the Activity you want to start, maybe using the ''Activity'' Tag or full-text search; | ||
:* Click found entity. | :* Click found entity. | ||
Launch particular | Launch a particular Activity version, e.g., to help with testing a non-stable version or revert to a previous one because the most recent version doesn't work for you. | ||
:* Go to the Browser and explore the | :* Go to the Browser and explore the Activity you want to start, maybe using the ''Activity'' Tag or full-text search; | ||
:* Click Home button for a found entity; | :* Click Home button for a found entity; | ||
:* You should find the list of Releases with the recent stable Release chosen, select any version you want; | :* You should find the list of Releases with the most recent stable Release chosen, select any version you want; | ||
:* Click the Launch button, or run it from the Browser, to run a newly selected Release. | :* Click the Launch button, or run it from the Browser, to run a newly selected Release. | ||
Line 294: | Line 298: | ||
:* Go to the Browser and explore the Context you want to work on at home; | :* Go to the Browser and explore the Context you want to work on at home; | ||
:* Pick up, select, collect these Contexts ( | :* Pick up, select, collect these Contexts (depending on implementation); | ||
:* Once at home where a Network is not accessible, you will see all chosen Contexts in the Browser; | :* Once at home, where a Network is not accessible, you will see all chosen Contexts in the Browser; | ||
:* A limited functionality ( | :* A limited functionality (depending on implementation) will be supported for these Contexts. | ||
=== Teaching === | === Teaching === | ||
Line 306: | Line 310: | ||
Fork me. | Fork me. | ||
:* Go to the Browser and explore the | :* Go to the Browser and explore the Activity you want to start, maybe using the ''Activity'' Tag or full-text search; | ||
:* Click Home button for the found entity; | :* Click Home button for the found entity; | ||
:* ''TODO'' | :* ''TODO'' | ||
== Infrastructure overview == | |||
The whole initiative is tailored by the following decisions: | |||
* The Sugar Network should be useful in off-line environments; | |||
* The scope of provided [[#Resources|resources]] should cover the full complement of low level collaborative behaviors between Network participants; where ''low level'' means that [[#Resources|resources]] are shared for all types of collaborative [[#Contexts|contexts]]; | |||
* The scope of provided [[#Resources|resources]] should be designed so that the Sugar Network is equally useful operating on-line as off-line; | |||
* The software architecture and interfaces are structured to stimulate a "doing" and "sharing" workflow. | |||
The whole Sugar Network is pictured by the following graphics: | |||
{| border="0" | |||
|- valign="top" align="let" | |||
| [[File:Sugar-network.png]] | |||
| Where, | |||
* '''Server'''<br>is shared data and services, in general. It might be a server accessible from the Internet (on-line case) or various distributed servers located, e.g., in schools (off-line case). See [[Platform_Team/Sugar_Network|technical pages]] for more details. | |||
* '''Conceptual level logic'''<br>The design logic and software code structures that reify the Sugar Network concepts. From a conceptual level, these designs and code standards represent a separate entity that operates inbetween the Clients and Servers. From the technical perspective, this level is represented by the Server [[Platform_Team/Sugar_Network/API|application programming interface (API)]] and [[Platform_Team/Sugar_Network/Objects_model|objects model]] in particular. | |||
* '''Client'''<br>is the software that allows Network participants to interact with the Sugar Network. These software components let people get access to the Sugar Network, and define how the Sugar Network should appear to users according to their needs. The user experience provided by the client software will vary from need to need, starting from a couple of elements in the existing software [[Wikipedia:Graphical_user_interface|GUI]] (when people even don't suspect they are interacting with the Sugar Network), and extending to clients that represent advanced conceptual elements of the Sugar Network as closely as possible. | |||
|} | |||
== Todo == | == Todo == |