version description DOCUMENT - template instructions

This document is a skeleton Version Description Document (VDD) intended
for use by Code 582 (Flight Software Branch) personnel as the basis for
a mission-specific Flight Software or related product delivery (e.g.,
simulation products).

Note that the instructions and change history pertain to the template
itself. These sections should be deleted when preparing the VDD. The
following style conventions are used throughout:

Text in this style (style name "Normal") is used for text that is
equally applicable to the entire VDD and should be included in the
Version Delivery Description without modification. All section headings
are in the same category (although their style names vary depending on
outline level).

\[Text in this style (style name "TAILORING ADVICE") is advice on how to
tailor the text in any specific section.\]

As the VDD is developed, the generic \[TAILORING ADVICE\] text should be
replaced with material that applies to the specific project.

General Tailoring Guidelines

This section includes general tailoring guidelines applicable to the
whole VDD. Specific recommendations are included in applicable sections.

All sections should be addressed, but the level of detail is left up to
the Team based on flight software complexity and customer
needs/expectations. The length and level of detail of the VDD should be
commensurate with the scope and complexity of the project. Section
headings may be added where necessary, but existing headings should not
be modified or deleted. If a particular section is not applicable to the
specific VDD under production, that fact should be noted under the
section heading, together with a brief explanation.

Finally, in the target VDD, this entire section ("Instructions") and the
Change History should be deleted.

Version Description DOCUMENT -- template Update History

\[This table shows the update history for the VDD Template. This section
should be deleted when creating an actual VDD.\]

+---------+---------+---------------------------------+---------------+
| Version | Date    | Description                     | Affected      |
|         |         |                                 | Pages         |
+=========+=========+=================================+===============+
| 0.1     | 1       | Table of Contents and "First    | All           |
|         | 0/13/03 | Draft"                          |               |
+---------+---------+---------------------------------+---------------+
| 0.2     | 1       | Modify to be in Memo format,    | All           |
|         | 0/14/03 | include comments                |               |
+---------+---------+---------------------------------+---------------+
| 0.3     | 1       | Incorporate comments from       | All           |
|         | 0/27/03 | reviewers                       |               |
+---------+---------+---------------------------------+---------------+
| 0.4     | 1       | Incorporate comments from       | All           |
|         | 0/29/03 | different reviewers             |               |
+---------+---------+---------------------------------+---------------+
| 0.5     | 1       | Incorporate comments from E.    | All           |
|         | 2/10/03 | Shell                           |               |
+---------+---------+---------------------------------+---------------+
| 0.6     | 0       | Incorporate comments from L.    | All           |
|         | 1/06/04 | Hoge, D. Simpson, Added Acronym |               |
|         |         | List                            |               |
+---------+---------+---------------------------------+---------------+
| 0.7     | 0       | Incorporated additional changes | All           |
|         | 6/08/04 | from Dan Berry                  |               |
+---------+---------+---------------------------------+---------------+
| 0.8     | 0       | Formatting changes only         | All           |
|         | 6/09/04 |                                 |               |
+---------+---------+---------------------------------+---------------+
| 0.9     | 0       | Change of name to "Version      | All           |
|         | 6/25/04 | Delivery Description"           |               |
+---------+---------+---------------------------------+---------------+
| 1.0     | 7/30/04 | Updates resulting from 7/29/04  | All           |
|         |         | walkthrough                     |               |
|         |         |                                 |               |
|         |         | (name changed back to "Version  |               |
|         |         | Description Document")          |               |
+---------+---------+---------------------------------+---------------+
| 1.1     | 9/30/04 | Changes resulting from e-mail   |               |
|         |         | responses to Branch review, and |               |
|         |         | Standards CCB discussions (9/29 |               |
|         |         | meeting)                        |               |
+---------+---------+---------------------------------+---------------+
| 1.2     | 11/3/05 | -Added Title Page               | 3             |
|         |         |                                 |               |
|         |         | -Implemented DCRs #135, 136 and | 4 and 5       |
|         |         | 137                             |               |
+---------+---------+---------------------------------+---------------+
| 1.3     | 10/     | Added release date - DCR #228   | 3             |
|         | 31/2006 |                                 |               |
+---------+---------+---------------------------------+---------------+
|         |         |                                 |               |
+---------+---------+---------------------------------+---------------+
|         |         |                                 |               |
+---------+---------+---------------------------------+---------------+
|         |         |                                 |               |
+---------+---------+---------------------------------+---------------+
|         |         |                                 |               |
+---------+---------+---------------------------------+---------------+
|         |         |                                 |               |
+---------+---------+---------------------------------+---------------+
|         |         |                                 |               |
+---------+---------+---------------------------------+---------------+
|         |         |                                 |               |
+---------+---------+---------------------------------+---------------+
|         |         |                                 |               |
+---------+---------+---------------------------------+---------------+
|         |         |                                 |               |
+---------+---------+---------------------------------+---------------+
|         |         |                                 |               |
+---------+---------+---------------------------------+---------------+
|         |         |                                 |               |
+---------+---------+---------------------------------+---------------+
|         |         |                                 |               |
+---------+---------+---------------------------------+---------------+

Flight Software Branch

FSW Version Description Document

\[Mission Acronym\]

Build: \[Build Identifier\]

Release Date: \[Date when all associated files are tagged for the Build
in CM\]

1.0 FSW Version Description

1.1 purpose and summary

\[Explain the purpose of this Build version of the FSW (or related
product). Summarize major new functionalities, features and/or problems
resolved in this version.

\[If this Build of FSW is integrated with FSW from another FSW subsystem
(e.g., ACS FSW is dependent on a C&DH FSW version), state the other
subsystem and the version number plus release date of that product.
Example: The MAP ACE FSW version X.Ya is compiled and linked with MAP
ROS FSW version x.ya released on xx/yy/zz and MAP GRSN FSW version x.ya
released on xx/yy/zz.\]

\[If this FSW delivery is dependent on a particular version of
simulators, tools, databases, etc. identify these dependencies.\]

1.2 new/Changed functionality in this VERSION

Table 1.2-1 identifies Mission CCRs that have been implemented in this
FSW version.

Table 1.2-1 --Mission CCRs Implemented in this Version

  -----------------------------------------------------------------------
  Mission   Title
  CCR \#    
  --------- -------------------------------------------------------------
  100       Implement Optical Select Mechanism

  200       
  -----------------------------------------------------------------------

Table 1.2-2 identifies new FSW functionality that has been implemented
and is integrated into this FSW version \[all functionality not
previously delivered must be included\]. Requirement references are
included.

Table 1.2-2 -- New Functionality in this Version

  ----------------------------------------------------------------------------
  No.   FSB DCR  Requirements   High Level Description of Functionality
        \# (or                  
        N/A )                   
  ----- -------- -------------- ----------------------------------------------
  1     200      2000           Memory Load and Dump

  2     210      3120, 3140,    Lamp Mechanisms
                 3160           
  ----------------------------------------------------------------------------

Table 1.2-3 identifies changes to FSW functionality from a previously
delivered FSW version and the DCRs associated with these changes.

Table 1.2-3 -- Changes to Previously Delivered Functionality

  ----------------------------------------------------------------------------
  No.   FSB DCR  Requirements   Functionality or Change Description
        \# (or                  
        N/A )                   
  ----- -------- -------------- ----------------------------------------------
  1     271      4135           Update Optical Select Mechanism Absolute Move
                                Table

  ----------------------------------------------------------------------------

1.3 MISSING Planned FEATURES AND KNOWN PROBLEMS

Table 1.3-1 identifies functions that were originally planned for this
release, but are absent \[make sure to provide reason for absence\].

Any workarounds that may apply are identified.

Information on currently open DCRs is available at \[identify the team's
web site URL\].

Refer to the Delivery Letter for any additional DCRs submitted after
preparation of this VDD.

Table 1.3-1 -- Functions absent from this Release

  ------------------------------------------------------------------------------------------------
  No.   Description                    Reason for       Affected      Workaround   Planned
                                       Absence          Requirement                Delivery
                                                        or Component               
  ----- ------------------------------ ---------------- ------------- ------------ ---------------
  1     Diagnostics                    Implementation   Req. 3004.3   Analyze      Version 2.3
                                       not ready.                     memory dumps 
                                                                      for          
                                                                      diagnostic   
                                                                      purposes.    

  2     Reconsider calculation in      Problem found    Optical       None         Version 2.4
        mechmove_Compute_Wait_Count.   during Build     Mechanisms    required at  
                                       integration      Task          this time.   
                                       test.                                       
  ------------------------------------------------------------------------------------------------

1.4 Development Tool Versions Associated with this FSW Version

\[Identify the versions of the Real-Time Operating System (RTOS) and any
other Commercial Off-The-Shelf (COTS) software products (e.g, a script
language) that are integrated with this FSW version. Add additional rows
to the table as needed\]

Table 1.4-1 identifies the versions of development tools used to
generate this FSW version:

Table 1.4-1 -- Development Tool Versions Associated with this FSW
Version

  -----------------------------------------------------------------------
  Tool Type.     Tool Name                                    Version
                                                              Used
  -------------- -------------------------------------------- -----------
  RTOS                                                        

  Compiler                                                    
  -----------------------------------------------------------------------

2.0 Delivered products

Table 2-1 identifies the locations of FSW products relevant to this FSW
Build. The version or date of the Build and where the product can be
located are provided. Changes from a previous VDD are identified.

Table 2-1 -- Delivered Products and their Locations

  ---------------------------------------------------------------------------
  Software Element       Changed    New       Location
                         with this  Version   
                         Version?   or Date   
  ---------------------- ---------- --------- -------------------------------
  Executable for this                         
  build                                       

  Installation                                
  Procedures & Special                        
  Instructions **(See                         
  Section 3.0)**                              

  Source Code of this                         \[Provide CM Tool retrieval
  FSW Build                                   label\]

  FSW Build Plan                              

  Annotated S/W Detailed                      
  Design Docs                                 

  Ground System T&C                           
  Database                                    

  Ground System Scripts                       
  developed by FSB                            

  Simulator and Test                          
  Data Generator                              
  Software \[ customize                       
  as appropriate \]                           

  Executable - Ground                         
  Tools associated with                       
  FSW (tools to build                         
  stored command loads,                       
  etc.)                                       

  Source Code - Ground                        
  Tools associated with                       
  FSW (tools to build                         
  stored command loads,                       
  etc.)                                       

  Unit Test Procedures                        

  Unit Test Data                              

  Unit Test Results                           

  FSW Make Files                              

  Linker & Compiler                           
  Configuration Files                         

  \[Add items as                              
  necessary\]                                 
  ---------------------------------------------------------------------------

3.0 INSTALLATION PROCEDURES

Table 3-1 identifies the nominal FSW Installation Procedure(s) for this
FSW Build onto the intended target system (including the commercial
applications used and the configuration settings). The procedure version
identifier, the date of the procedure and where it can be located are
also provided.

\[Add a line to this table for each target that has a unique
installation procedure\]

Table 3-1 FSW Installation Procedure(s)

+--------------+----------------+--------+---------------------------+
| Destination  | Filename       | V      | Location                  |
|              |                | ersion |                           |
| (Target      |                | and    |                           |
| System)      |                | Date   |                           |
+==============+================+========+===========================+
| Destination  | Installation   | V      | Location 1                |
| #1           | Proc 1         | ersion |                           |
|              |                | 1.0,   |                           |
|              |                | 10     |                           |
|              |                | /20/03 |                           |
+--------------+----------------+--------+---------------------------+
| Destination  | Installation   | V      | Location 2                |
| #2           | Proc 2         | ersion |                           |
|              |                | 1.4,   |                           |
|              |                | 10     |                           |
|              |                | /24/03 |                           |
+--------------+----------------+--------+---------------------------+

4.0 Configuration summary and version identification

\[Provide the location of the CM system where this version can be found,
and provide the CM Tag reference for this version.\]

\[Provide the means for a user to identify this particular version of
FSW once loaded onto the target hardware. E.g., checksum verifications,
version ID downlinked in telemetry, etc. Version identifiers are
required for Boot PROM, EEPROM, RAM, etc. as appropriate for the system
being delivered.\]

Acronyms

ACS Attitude Control System

C&DH Command and Data Handling

CM Configuration Management

COTS Commercial Off-The-Shelf

DCR Discrepancy/Change Request

ETU Engineering Test Unit

FSB Flight Software Branch

FSW Flight Software

I&T Integration & Test

RTOS Real-Time Operating System

T&C Telemetry and Command

URL Universal Resource Locator

VDD Version Description Document