Skip to content

External plugin SQA requirements

Jump to bottom
Congjian Wang - INL edited this page Dec 4, 2020 · 7 revisions

Software Quality Assurance for RAVEN-based plugins

  • The RAVEN SQA documentation and process is explained/listed at RAVEN SQA PAGE

  • Any RAVEN-based plugin (Software products using the PLUGIN system in RAVEN) can refer to the RAVEN SQA plan, process and documentation if compliant with the RAVEN sqa process.

  • The derived RAVEN-based Plugin (software) might be covered under the RAVEN SQA, if the RAVEN process and plan is fully adopted and followed (documenting, if any, deviations from the original plan)

  • The RAVEN TEAM is here providing tools that can be used for compiling the SQA plan for the derived RAVEN-based plugins. The RAVEN TEAM is not responsible of the SQA compliance of the derived software (and, in case, failing to be compliant)

Minimum required documentation

The RAVEN SQA Plan is condensed in the following document:

  • PLN-5552, RAVEN and RAVEN Plug-ins Software Quality Assurance and Maintenance and Operations Plan. This plan covers the following SQA documents/sections:
    • Software Quality Assurance Plan (SQA)
    • Configuration Management Plan (CMP)
    • Standards Document
    • Software Test Plan (STP)
    • IT Asset Maintenance Plan
    • Verification and Validation Plan (V&V)

In addition to the reference to the above plan, A RAVEN-based plugin must produce the following minimum documentation:

  • Base Documents/Digital Entries
    • SSD, Safety Software Determination
    • QLD, Quality Level Determination
    • AME, Asset Management Entry (For INL Enterprise Architecture Entry)
  • Requirements and Traceability (the following documents can be combined in a single document)
    • SPC, Software Requirements Specifications
    • RTM, Requirements Traceability Matrix
  • Configuration List
    • LST, Configuration Item List
  • Design
    • SDD, Software Design Description
  • User Documentation
    • User Manual (minimum requirement)
    • Other optional user documentation (e.g. Theory manual, etc.)

If the software presents some deviations from the PLN-5552 plan (e.g. Coding Standards, etc.), those MUST be documented in a separate document:

  • Deviations Document
    • Document for reporting all the deviations with respect to the PLN-5552 plan

In the following, a dashboard of the required documentation is reported

INL internal procedure for these minimum required documentations:

  • Contact [email protected] and Stella McKarty for the QLD and SSD forms (or ask them for the right point of contact)
  • Request a document number at the following address: https://dcr.inl.gov/DocNumber (Click Button "Create New Document Number). Look for the different document types (SDD, LST, SPC, RTM)
  • Create a CTM entry for the application (https://ctm.inl.gov/), this is for INL Enterprise Architecture Entry
  • Once you created the IDs for all the documents, you can go to the eCR system (https://ecr.inl.gov/pls/ecr/drf_100.empty_drf)
    • Type of action: Create
    • In the section "Document ID" search for the previously generated ID (e.g. LST-XXXX, SDD, SPC, RTM) and complete the form
    • At this point, the review process begins.
Clone this wiki locally