| Version 28 (modified by todor, 17 years ago) (diff) |
|---|
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.
Related
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 these include only:
- sophie2-gui-elements
- DND table (empty sheet for now)
- Most of the specifications will be in the tasks' analyses. We must figure a way for easy access to them.
- The Sophie software requirements specifications are stored here.
- Specifications about Author, Reader, Server must be stored in their corresponding folders in SVN Repository prop-veda\doc\specification
- All diagrams and other images that are used in the specifications for visual purposes must be stored in prop-veda\doc\specification\Diagrams
The next paragraph contains the current artifacts and where they are stored. On the other hand the Global Spec Structure page must present the global spec structure at any time.
- In the SVN Repository we are keeping:
- List with the major functions for Sophie 2. This is available in the repository prop-veda\doc\major_features.txt
- Decomposition of Sophie available at prop-veda\doc\sophie1-decomposition.mm
- Most of our ready specifications are stored in prop-veda\doc\specification folder. It contains:
- subfolders for Author, Reader, and Server as main parts of the Sophie project. Each subfolder contains specifications for the part that it is named after.
- folder with available diagrams that are used for sample purposes. The are stored in the folder called Diagrams.
- 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.
- file spec_master.pdf which is exported version of spec_master.odm. It is for showing purposes.
- We are keeping following artifacts in trac:
- SoftwareRequirementsSpecification is wiki page with the available for the moment functional specifications.
- Some specification artifacts are stored in Google Docs. These are:
- Spreadsheet of the Sophie 2 GUI elements and Drag and Drop behavior spreadsheet, which are available as a sheets of the following document.
Sophie2 GUI Elements and DND Table
- Spreadsheet of the Sophie 2 GUI elements and Drag and Drop behavior spreadsheet, which are available as a sheets of the following document.
In the process of work there will be added some new specifications and these structure may change or be removed. It is necessary to keep track of our artifacts and their change must be booked down in the global spec structure.
