wiki:GLOBAL_SPEC_STRUCTURE_R0
Last modified 14 years ago Last modified on 09/24/08 14:48:23

Analysis

Overview

Global Spec Structure must be our "road map" for the Global Specification. It must contain requirements what artifacts will be kept, where we will store them, and how they must be structured.

Task requirements

  • Define what artifacts will be kept
  • Define which file formats for which artifacts will be used
    • sophie2-gui-elements - google spreadsheet
    • master_spec - odm
    • DND Table - define what will be the columns of the table - what can be drag and where can be drop, where this document will be kept
  • Define what other documents we will need, what their structure will be, and where they will be kept
  • Define where the artifacts will be kept
    • Google Docs
    • SVN Repository
    • Trac

Task result

The result of this task must be a wiki page.

Implementation idea

  • It is good to keep our artifacts in such ways that they are as easy as possible to manage.
  • We must avoid scattering artifacts and create such structure that doesn't contain any unnecessary documents, but cover all needed specifications.

Currently we store following artifacts:

  • sophie2-gui-elements - google spreadsheet
  • master_spec - odm
  • DND Table - define what will be the columns of the table - what can be drag and where can be drop, where this document will be kept

How to demo

Show the structure of the available artifacts and explain in what formats and where they will be kept. Explain how they will be managed, and how will be added new ones.

Design

  • All spreadsheets must be in only onegoogle doc. Each table will be presented by its own sheet. For now this document includes only:
    • sophie2-gui-elements
    • DND table (empty sheet for now)

We must have in mind the specifications that we already have, because they might be helpful when writing new. For now we have:

  • The Sophie software requirements specifications are stored here.
    • Specifications about Author, Reader, Server are stored in their corresponding folders in SVN Repository prop-veda/doc/specification
    • File called spec_master.odm that combines reader, author and server specification in one general document. This file is for easier group editing of the upper mentioned groups of specifications. It is stored in the SVN Repository prop-veda/doc/specification.
    • File spec_master.pdf which is exported version of spec_master.odm. It is for showing purposes.
    • All diagrams and other images that are used in the specifications for visual purposes must be stored in prop-veda/doc/specification/Diagrams
    • Most of the specifications will be in the tasks' analyses. We must figure a way for easy access to them.
    • Every change of the global spec structure must be synchronized with GLOBAL_SPEC_STRUCTURE

Our goal is to combine information from them and use it in our future analyses, and store our specifications in one google spreadsheet with different sheets to requisite specifications (for example DND Table is separate sheet). The information of analyses that contain specifications must be included in one index page.

  • must create index page for specifications in analyses
  • must create google spreadsheet for the necessary tables

Implementation

GLOBAL_SPEC_STRUCTURE

Testing

Log

  • Analyzing : Tanya, toshko - 25 min
  • Analysis Review: Peko - 3.5 - OK - 5 mins.
  • Designing : todor
  • Design Reivew: Peko - 4 - OK - 5 mins.
  • Implementing : todor
  • Implementation Review: Peko - 2 - Implementation and Design are inconsistent. Link for the structure wrong. - 10 mins
  • Implementation Reivew2: Peko - 4 - OK - 5 mins.
  • Testing :