[[BackLinksMenu]] [[TicketQuery(summary=GLOBAL_SPEC_STRUCTURE_R1, format=table, col=summary|owner|status|type|component|priority|effort|importance, rows=description|analysis_owners|analysis_reviewers|analysis_score|design_owners|design_reviewers|design_score|implementation_owners|implementation_reviewers|implementation_score|test_owners|test_reviewers|test_score|)]] = Analysis = == Overview == Current [wiki:GLOBAL_SPEC_STRUCTURE] contains obsolete information. Redesign and maintain it. Specify a consistent gui elements concept. == Task requirements == * Schedule a discussion about application behavior, create a wiki page containing the results of the discussion (GUI elements and user interactions). * Behavior similar to Sophie 1 * New things * Review [wiki:GLOBAL_SPEC_STRUCTURE] * Divide the "specification" term into "specification" and "user documentation" * Point user documentation as specification task * Link user doc tasks from [wiki:ITERATION_02b] * Create structure for user documentation and fill it with corresponding elements. * Decide where do keyboard shortcuts belong (and other similar elements if any will be supported - for example mouse gestures.) * Review existing spreadsheet http://spreadsheets.google.com/ccc?key=p-0Oq38E1aysuTs69KE68Nw and improve it's structure if needed == Task result == Improved [wiki:GLOBAL_SPEC_STRUCTURE] == Implementation idea == Create a wiki page to store the discussion results. == Related == [wiki:GLOBAL_SPEC_STRUCTURE_R0] [[BR]] [wiki:GLOBAL_SPEC_STRUCTURE] [[BR]] http://spreadsheets.google.com/ccc?key=p-0Oq38E1aysuTs69KE68Nw == How to demo == Show http://spreadsheets.google.com/ccc?key=p-0Oq38E1aysuTs69KE68Nw , explain the User Documentation, keyboard shortcuts. = Design = * Revise the current table in [wiki:GLOBAL_SPEC_STRUCTURE]: * Change the diagrams link: [svn://sophie2.org/sophie2/trunk/sophie2-platform/doc/spec-diagrams] * Add user documentation, which is also a specification artifact * Decide if it is needed to copy the artifacts with "not available" links from the old repository to the new one and link them in the document * Decide what to do with the idea for a [wiki:SPEC_INDEX] document (see the previous revision of this task). Will this document be used, which task should fill the document, etc. * Discuss whether to replace the table with a structured text - this way a longer descriptions/explanations could be made without affecting the good look of the document. * Revise the google spreadsheet: * decide whether to split the different objects into different sheets (for example menus, tabs, etc) - with the growing of the specifications it might become unreadable. * Make a better outlook of the document - the tree structure is not good; the column descriptions could be in brackets, after column names. * Discuss the name of the spreadsheet - sophie2-gui-elements is not correct, since it contains DND table, too. A better name would be "sophie2-user-interactions" * Discuss where to put the extra functionalities of user interaction: keyboard shortcuts, mouse gestures (for example, a table "extra" in the spreadsheet). Discuss also whether these will be available: for example, F1 should invoke the user help. * Updating information on the current tables is part of another task. * All discussions' result would be better to be stored in the existing [wiki:GLOBAL_SPEC_STRUCTURE] and applied to the corresponding documents. = Implementation = ^(Implementation results should be described and linked here (from the wiki or the repository))^ = Testing = = Comments = ^(Write comments for this or later revisions here.)