wiki:GLOBAL_SPEC_STRUCTURE_R1

Version 16 (modified by kyli, 16 years ago) (diff)

--

Error: Macro BackLinksMenu(None) failed
compressed data is corrupt

Error: Macro 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|) failed
current transaction is aborted, commands ignored until end of transaction block

Analysis

Overview

Current 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 GLOBAL_SPEC_STRUCTURE
  • Divide the "specification" term into "specification" and "user documentation"
    • Point user documentation as specification task
    • Link user doc tasks from 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 GLOBAL_SPEC_STRUCTURE

Implementation idea

Create a wiki page to store the discussion results.

GLOBAL_SPEC_STRUCTURE_R0
GLOBAL_SPEC_STRUCTURE
​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 GLOBAL_SPEC_STRUCTURE:
    • Change the diagrams link: ​svn://sophie2.org/sophie2/trunk/sophie2-platform/doc/spec-diagrams
    • Fix the "not available" links: the folders must be linked with their path in the repository, and the missing documents must be copied from the old repository and linked.
    • We need a specification for the user documentation - its structure, its content. So, link the user_doc tasks until now, which have analyses (the analyses are actually specifications).
    • Replace the table with a structured text (or several smaller tables - which is better) - this way longer descriptions/explanations could be made without affecting the good look of the document.
  • Revise the google spreadsheet:
    • 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 sheet "extra" in the document). Discuss also whether these will be available: for example, F1 should invoke the user help.
    • Discuss what extra behavior from Sophie1 is expected.
    • Updating information on the current tables is part of another task.
  • All discussions' results would be better to be stored in the existing 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.)