SharedPaper Design Doc

From WorldForgeWiki
Jump to: navigation, search
Atlas Workspace Initial Spec.png

Contents

Data Model Classes

Node

May have subnodes.

May have key-value properties.

Has a name, (optional) description and (optional) icon.

May also have edges to other nodes (with properties? Or different types of edges / ports?).


Edge

A connection between two nodes.

May have properties.

May have corners, with coordinates and possibly a set of key-value properties.


UI

Initial version will have chat + mind map + access control.


Actors

  • Designer - someone who more or less actively participates in some project supported by the Shared Paper server.
  • Spectator - someone who is interested in following the project supported by the Shared Paper server.
  • Administrator - someone who is responsible for keeping the Shared Paper server working, and updating user rights when needed.


Some Mini Use Cases

(Note that where the use case says Mind Map, it is often also applicable for other document types such as whiteboards and game maps.)

  • As a designer, I want to be able to create a new Mind Map on some topic, and have it be linked to from appropiate places so that others can find it easily.
  • As a designer, I want to be able to use a mind map to jointly create a design with other developers.
  • As a designer, I want to be able to use a mind map to discuss and clarify my design thoughts with other developers and spectators, and get feedback on them (feedback could come also sometime after I have created the mind map, when someone else is looking at it).
  • As a designer or spectator, I want to browse existing mind maps, and see which ones are being worked on, and find mind maps interesting or relevant fot me.
  • As a designer or spectator, when viewing or editing a mind map, I want to be able to see what the other designers are doing or focusing their attention at, and who is spectating.
  • As a designer, when I edit a mind map I want to leave some comments on what I am doing, for others to see later.
  • As a designer or spectator, when reviewing a mind map, I want to see the date of a mind map, and who worked on it, and their chat log and/or comments, to be able to determine if the information is up to date, and relevant for me.
  • As a designer or administrator or spectator, I want to be able to mark mind maps as out of date if they are, or to tag them with relevant tags, or to add other feedback or ratings or such to them.
  • As a designer or spectator discussing a mind map, I want to be able to draw attention to some detail of it that I am talking about. (Kind of like minimap ping, or tagging an item with a temporary flag or symbol, colored according to the spectators color. The marks should also be stored in the log, maybe integrated in the chat -> *zzorn pings Orc Hill, <zzorn> lets add some trees around this),
Personal tools
Namespaces

Variants
Actions
Navigation
Toolbox