Skip to content
This repository has been archived by the owner on Aug 30, 2024. It is now read-only.

Home

Jump to bottom
chris grzegorczyk edited this page Oct 14, 2012 · 60 revisions

Overview

This repository is for handling the architectural documents related to specification and design of Eucalyptus features. Notably, it is not the source for functional requirements: those are in JIRA. Relatedly, the contents here will be reflected in JIRA.

The organization of the repository reflects the long-lived nature of a features true specification. That is, the specification and design work related to a feature's implementation for a particular release often corresponds with only a portion of the entire feature's implementation. Moreover, feature's specification evolves over time as the requirements, architecture, and upstream specifications evolve.

We have four classes of documents which contribute to the definition of the system:

  1. Requirements Documents [1]detail the functionality as drawn from various stakeholders.
  2. Specification Documents are overarching definitions of a feature's architecture and functionality.
  3. Generational Documents specific to the context and determined by the constraints of a particular release.
  4. Architectural documents[2] describe the overall realized design and architecture of the system as released.
    For more documents see the:
    JIRA bug tracker.

See Also

Table of Contents

Documents

There are two kinds of documents for which this repository is the canonical reference: specification and generational documents.

Document Categories

Documents By Category
Release 3.0
pending 		3.1
pending 		3.2 3.3
pending
Feature pending
Component pending

Specification Documents

These documents are intentional and intensional[3]:

  • are "timeless" in that they are overarching and meant to be definitive of the feature overall.
  • evolve over time independent of the features current implementation status.
  • reflect our current understanding of the features definition in the broadest sense.
Specification documents consist of:
  • Specification: overall technical specification of the functional and architectural/quality characteristics.
  • High level design/Architecture: definition of fundamental components, interfaces, behaviours including information, control, and concurrency models.
  • Supporting Documents: API/Service specifications, client tool chains, WSDLs, TCKs.

Generational Documents

These documents are specific to a release and meant to serve the tasks surrounding the planning, design, implementation, and delivery of a feature.

  • support the scoping, design, and implementation effort of the feature during that release.
  • defining the design and implementation objectives and details for a particular version of a feature.
  • specific to the context and determined by the constraints of a particular release time frame.
  • change as needed to support the above objectives and are quiesced after those tasks are completed.
Generational documents consist of:
  • Functional requirements: as identified by a corresponding epic in JIRA
  • Specification: release-specific technical interpretation of functional requirements

References

  1. ^ https://eucalyptus.atlassian.net/secure/Dashboard.jspa
  2. ^ https://github.com/eucalyptus/architecture-docs
  3. ^ http://en.wikipedia.org/wiki/Intensional_definition
Clone this wiki locally