Changeset 49453ec in rtems-docs


Ignore:
Timestamp:
Dec 1, 2018, 2:17:11 PM (5 months ago)
Author:
Marçal Comajoan Cara <mcomajoancara@…>
Branches:
master
Children:
8059b68
Parents:
602561f
git-author:
Marçal Comajoan Cara <mcomajoancara@…> (12/01/18 14:17:11)
git-committer:
Joel Sherrill <joel@…> (12/18/18 00:34:58)
Message:

eng/appendix-a: convert to a table

Convert text to a table, TBDs into comments and add missing
formatting.

This work was part of GCI 2018.

File:
1 edited

Legend:

Unmodified
Added
Removed
  • eng/appendix-a.rst

    r602561f r49453ec  
    99
    1010An effort at NASA has been performed to suggest a core set of artifacts
    11 (as defined by BOTH NASA NPR 7150.2B and DO-178B) that can be utilized
     11(as defined by **BOTH** NASA NPR 7150.2B and DO-178B) that can be utilized
    1212by a mission as a baselined starting point for “pre-qualification”
    1313for (open-source) software that is intended to be utilized for flight
     
    2121meeting the intent of the artifacts with information simply needing
    2222organized and formalized.  The table below lists the general category,
    23 artifact name, and its intent.  Please note that this table does NOT
     23artifact name, and its intent.  Please note that this table does **NOT**
    2424represent all the required artifacts for qualification per the standards;
    2525instead, this table represents a subset of the most basic/core artifacts
     
    2727effort.
    2828
    29 TBD convert to a table; see original PDF for guidance on desired look
    30 TBD The PDF is in https://ftp.rtems.org/pub/rtems/people/joel/sw_eng_hb/
     29.. COMMENT: TBD convert to a table; see original PDF for guidance on desired look
     30.. COMMENT: TBD The PDF is in https://ftp.rtems.org/pub/rtems/people/joel/sw_eng_hb/
    3131
    32 .. COMMENT: ====================================== BEGIN
    33 Table 1. Core Qualification Artifacts
     32.. table:: Table 1. Core Qualification Artifacts
     33   :class: rtems-table
    3434
    35 Category        Artifact        Intent
    36 Requirements    Software Requirements Specification (SRS)
    37 
    38 Requirements Management The project shall document the software requirements.
    39 
    40 The project shall collect and manage changes to the software requirements.
    41 
    42 The project shall identify, initiate corrective actions, and track until closure inconsistencies among requirements, project plans, and software products.
    43         Requirements Test and Traceability Matrix       The project shall perform, document, and maintain bidirectional traceability between the software requirement and the higher-level requirement.
    44         Validation      The project shall perform requirements validation to ensure that the software will perform as intended in the customer environment.
    45 
    46 
    47 Design and Implementation       Software Development or Management Plan A plan for how you will develop the software that you are intent upon developing and delivering.
    48 
    49 The Software Development Plan includes the objectives, standards and life cycle(s) to be used in the software development process. This plan should include: Standards: Identification of the Software Requirements Standards, Software Design Standards, and Software Code Standards for the project.
    50 
    51         Software Configuration Management Plan  To identify and control major software changes, ensure that change is being properly implemented, and report changes to any other personnel or clients who may have an interest.
    52 
    53         Implementation  The project shall implement the software design into software code.
    54 
    55 Executable Code to applicable tested software.
    56 
    57         Coding Standards Report The project shall ensure that software coding methods, standards, and/or criteria are adhered to and verified.
    58         Version Description Document (VDD)      The project shall provide a Software Version Description document for each software release.
    59 
    60 Testing and Software Assurance Activities       Software Test Plan      Document describing the testing scope and activities.
    61         Software Assurance/Testing Procedures
    62         To define the techniques, procedures, and methodologies that will be used.
    63 
    64         Software Change Report / Problem Report The project shall regularly hold reviews of software activities, status, and results with the project stakeholders and track issues to resolution.
    65 
    66         Software Schedule       Milestones have schedule and schedule is updated accordingly.
    67 
    68         Software Test Report / Verification Results     The project shall record, address, and track to closure the results of software verification activities.
    69 
    70 Problem report - Describes the process non-compliance with plans, output deficiency, or software anomalous behavior, and the corrective action taken.
    71 
    72 The project shall ensure that the software code is unit tested per the plans for software testing.
    73 
    74 
    75 Usability       Software User’s Manual        The Software User Manual defines user instructions for the software.
    76 .. COMMENT: ====================================== END
     35   +----------------+-----------------------+---------------------------------+
     36   | Category       | Artifact              | Intent                          |
     37   +================+=======================+=================================+
     38   | Requirements   | Software Requirements | The project shall document the  |
     39   |                | Specification (SRS)   | software requirements.          |
     40   |                |                       |                                 |
     41   |                |                       | The project shall collect and   |
     42   |                |                       | manage changes to the software  |
     43   |                |                       | requirements.                   |
     44   |                | Requirements          |                                 |
     45   |                | Management            | The project shall identify,     |
     46   |                |                       | initiate corrective actions,    |
     47   |                |                       | and track until closure         |
     48   |                |                       | inconsistencies among           |
     49   |                |                       | requirements, project plans,    |
     50   |                |                       | and software products.          |
     51   |                +-----------------------+---------------------------------+
     52   |                | Requirements Test and | The project shall perform,      |
     53   |                | Traceability Matrix   | document, and maintain          |
     54   |                |                       | bidirectional traceability      |
     55   |                |                       | between the software            |
     56   |                |                       | requirement and the             |
     57   |                |                       | higher-level requirement.       |
     58   |                +-----------------------+---------------------------------+
     59   |                | Validation            | The project shall perform       |
     60   |                |                       | validation to ensure that the   |
     61   |                |                       | software will perform as        |
     62   |                |                       | intended in the customer        |
     63   |                |                       | environment.                    |
     64   +----------------+-----------------------+---------------------------------+
     65   | Design and     | Software Development  | A plan for how you will develop |
     66   | Implementation | or Management Plan    | the software that you are       |
     67   |                |                       | intent upon developing and      |
     68   |                |                       | delivering.                     |
     69   |                |                       |                                 |
     70   |                |                       | The Software Development Plan   |
     71   |                |                       | includes the objectives,        |
     72   |                |                       | standards and life cycle(s) to  |
     73   |                |                       | be used in the software         |
     74   |                |                       | development process. This plan  |
     75   |                |                       | should include: Standards:      |
     76   |                |                       | Identification of the Software  |
     77   |                |                       | Requirements Standards,         |
     78   |                |                       | Software Design Standards,      |
     79   |                |                       | and Software Code Standards for |
     80   |                |                       | the project.                    |
     81   |                +-----------------------+---------------------------------+
     82   |                | Software              | To identify and control major   |
     83   |                | Configuration         | software changes, ensure that   |
     84   |                | Management Plan       | change is being properly        |
     85   |                |                       | implemented, and report changes |
     86   |                |                       | to any other personnel or       |
     87   |                |                       | clients who may have an         |
     88   |                |                       | interest.                       |
     89   |                +-----------------------+---------------------------------+
     90   |                | Implementation        | The project shall implement the |
     91   |                |                       | software design into software   |
     92   |                |                       | code.                           |
     93   |                |                       |                                 |
     94   |                |                       | Executable Code to applicable   |
     95   |                |                       | tested software.                |
     96   |                +-----------------------+---------------------------------+
     97   |                | Coding Standards      | The project shall ensure that   |
     98   |                | Report                | software coding methods,        |
     99   |                |                       | standards, and/or criteria are  |
     100   |                |                       | adhered to and verified.        |
     101   |                +-----------------------+---------------------------------+
     102   |                | Version Description   | The project shall provide a     |
     103   |                | Document (VDD)        | Software Version Description    |
     104   |                |                       | document for each software      |
     105   |                |                       | release.                        |
     106   +----------------+-----------------------+---------------------------------+
     107   | Testing and    | Software Test Plan    | Document describing the testing |
     108   | Software       |                       | scope and activities.           |
     109   | Assurance      +-----------------------+---------------------------------+
     110   | Activities     | Software              | To define the techniques,       |
     111   |                | Assurance/Testing     | procedures, and methodologies   |
     112   |                | Procedures            | that will be used.              |
     113   |                +-----------------------+---------------------------------+
     114   |                | Software Change       | The project shall regularly     |
     115   |                | Report / Problem      | hold reviews of software        |
     116   |                | Report                | activities, status, and results |
     117   |                |                       | with the project stakeholders   |
     118   |                |                       | and track issues to resolution. |
     119   |                +-----------------------+---------------------------------+
     120   |                | Software Schedule     | Milestones have schedule and    |
     121   |                |                       | schedule is updated             |
     122   |                |                       | accordingly.                    |
     123   |                +-----------------------+---------------------------------+
     124   |                | Software Test         | The project shall record,       |
     125   |                | Report / Verification | address, and track to closure   |
     126   |                | Results               | the results of software         |
     127   |                |                       | verification activities.        |
     128   +----------------+-----------------------+---------------------------------+
     129   | Usability      | Software User’s       | The Software User Manual        |
     130   |                | Manual                | defines user instructions for   |
     131   |                |                       | the software.                   |
     132   +----------------+-----------------------+---------------------------------+
    77133
    78134In an effort to remain lightweight and sustainable for open-source
Note: See TracChangeset for help on using the changeset viewer.