wiki:GLOBAL_SPEC_STRUCTURE_R2

Version 9 (modified by deyan, 16 years ago) (diff)

--

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

Error: Macro TicketQuery(summary=GLOBAL_SPEC_STRUCTURE_R2, 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

The Global specification provides artifacts that can produce useful specification and are very helpful for the analysis and user documentation.

Task requirements

  • Review existing artifacts
  • Create a wiki page for the visual elements (according to naming conventions)
  • Find out how to generate the visuals tree1
  • Choose a layout for the page (See implementation idea.)
    • It should contain at least element name, link to related diagrams and tasks.
  • Fill in the visuals tree into the page according to the chosen design
  • Create a similar structure for the scene visual elements
  • Choose whether to create a new format for the drag n drop table
    • If you do - move it to a wiki page and consider following
      • Split the dnd table into layout to page, page to layout, page to operating system, os to page, os to layout (or arrange it)

1 The visuals tree contains all of the elements of the layout of Sophie.

Task result

Wiki pages, containing specifications. This specifications will be filled in during this iteration in GLOBAL_SPEC_MANAGING_R3 and GLOBAL_SPEC_MANAGING_R4

Implementation idea

Take the managing tasks too and implement them at once. Creating specification diagrams templates page might be useful.

GLOBAL_SPEC_STRUCTURE
GLOBAL_SPEC_MANAGING_R3

How to demo

Show the newly created pages.

Design

  • The visuals tree is generated from the experimental branch. It contains few of the visual elements, but is enough to create a structure prototype.
  • An idea of what information will be included is taken from the existing google document
  • The tree will contain element names
  • A new wiki page template with needed information for the elements will be created. It will contain
    • Type
    • Description
    • Diagram
    • Tooltip
    • Mouse Behavior
    • Keyboard Behavior
    • Mouse + Keyboard
    • Triggered by
    • OS Specific
    • Related tasks

Advantages of using sections are that these things will be searchable, you can do a search for "== Tooltip ==" for example to get a list of elements that have a tooltip. This pages can be filled in and included as part of the analysis in the overview part.

  • Existing artifacts will be migrated during the next iterations
  • A section in the specification index will contain explanation of common elements - for example frame, tooltip, tab, palette.
  • Similar structure (as the tree) will be included for the elements in the book. It will contain
    • Type
    • Description
    • Diagram
    • Tooltip
    • Mouse Behavior
    • Keyboard Behavior
    • Mouse + Keyboard
    • Triggered by
    • Related tasks

but the triggered by should be renamed somehow, for example "Created by".

Implementation

(Describe and link the implementation results here (from the wiki or the repository).)

Testing

(Place the testing results here.)

Comments

Attachments