Skip to main content

55 docs tagged with "How to Guide"

View all tags

Safety Handbook

The purpose of this handbook is to describe how to perform quality assurance during a safety project in addition to the Quality Management System. Other documents with "Safety Handbook" in the title belong to this Safety Handbook. Although existing as separate documents they are functionally integrated parts and as such are linked in the Safety Handbook. Those documents are:

1 Safety Handbook - NonSIL: Recommended SIL1

For the development of a non-SIL classified function with a recommended safety integrity level of SIL 1 during development, this document lists measures for avoiding systematic failures during PHASE 1 up to PHASE 7.

2 Safety Handbook - NonSIL - Library

For the development of a non-SIL classified library, this document lists measures for avoiding systematic failures during PHASE 1 up to PHASE 7.

3 Safety Handbook - SIL1

For the development of a function with a required safety integrity level SIL 1, this document lists measures for avoiding systematic failures during PHASE 1 up to PHASE 7.

4 Safety Handbook - SIL2

For the development of a function with a required safety integrity level SIL 2, this document lists measures for avoiding systematic failures during PHASE 1 up to PHASE 7.

5 Safety Handbook - SIL3

For the development of a function with a required safety integrity level SIL 3, this document lists measures for avoiding systematic failures during PHASE 1 up to PHASE 7.

7 Safety Handbook - Artifacts

The purpose of this document is to provide an overview of the safety-related artifacts that need to be created during the development of a safety product in addition to the artifacts required for related non-safety development.

8 Safety Handbook - Reference List

The purpose of this document is to provide an overview of the documents referenced in the Safety Handbook that are used for the development of functionally safe products within PCP R&D.

Guideline for HAZOP

The objective of this guideline is to describe the procedure of how to perform HAZOP analyses for Electrical/Electronic/Programmable (E/E/PE) safety-related systems, explain the reasons for performing a HAZOP, give an overview of the process, and explain the terminology and concept. The HAZOP is a recommended technique in IEC 61508.

How To Handle a Product Issue

A product issue is a uniquely identified problem impacting a product, requiring clear communication with various stakeholders. It must be documented with accurate information and version details and managed in parallel with bug management and product releases.

How-to Adopt Standard Work Item Templates

An existing Azure DevOps (ADO) project - on-premises or in the cloud - may differ from the current standard PCP work item templates due to historical reasons or tailoring. This guide lists the steps and tools to adopt standard work item templates in an existing ADO project with existing data.

How-to Change Standard Work Item Templates

This guide focuses on describing the practical change of the work item, starting from a process change request received, to the completion of a pull request updating the template.

How-to conduct internal FSM Audits

This guideline aims to describe how to conduct internal Functional Safety Management (FSM) audits in ABB PCP R&D, as well as how to monitor and handle external FSM audits conducted by the Independent Safety Assessor (ISA) for ABB PCP R&D.

How-to Create a Temporary Correction

In emergency situations, software corrections may be required in a short time frame to solve a critical issue on the customer site. This type of emergency correction will be handled as a temporary correction (TC).

How-to Create Process Change Requests

This guide takes you through the steps to initiate a change on the PCP R&D Processes website by creating a process change request (PCR). It also includes information on how the process teams handle submitted PCRs and updates to the R&D processes.

How-to Create Test Plans and Test Suites

The purpose of this guide is to provide hands-on support to the roles involved in setting up a test plan and test suites in Azure DevOps (ADO), demonstrating the product's test coverage.

How-to Edit, Review, and Approve Markdown Files

This guide describes how to use Markdown to document technical information using the Azure DevOps (ADO) wiki. The Markdown files can be reviewed, approved, and baselined with the code. The code and technical documentation can be restored from the same baseline when a released product needs to be updated.

How-to Handle Deferred Bugs

During the development of a release, if a bug is found but the CCB decides to fix it in a later version, the bug is deferred. After the official release, it will then be a known bug in the product or system.

How-to Handle End-of-Life Software

This guide describes the steps to handle 3rd-party software that has reached end-of-life (EOL) and "Operational risks" identified by Black Duck for OSS.

How-to Handle Enhancements

A work item of type "Bug" can be used to suggest an enhancement, something that is not a real defect, but an idea for improvement. This guide describes how to handle enhancements as bugs.

How-to Handle Minor Hardware Revisions

Some minor hardware changes to products can be implemented without setting up a project. This guide describes the steps involved and the checklists that shall be used.

How-to Handle Software Vulnerabilities

This guide describes the process for handling software vulnerabilities in products within PCP R&D. It includes instructions on everything from recording a description of a reported issue to documenting and communicating its remediation.

How-to Handle Suspected Malware in ABB Software

This guide describes how to determine if a malware suspicion is correct or false and how to handle both scenarios. It also includes information about how malware is detected in ABB software.

How-to Handle Vulnerabilities in 3rd-Party Software

This document describes steps to be taken when vulnerabilities are detected for any type of 3rd-party components like OSS, runtime cost, development cost- free runtime, components used in development and testing of our products.

How-to Initiate a Project

When starting a new project there are several tasks to be performed to ensure that tools and systems are well set up when M0/G0, M1/G1, and M2/G2 are reached.

How-to Manage Bugs

A bug is an unexpected problem in the software or hardware which can be reported for any issue in a product by e.g. product managers, product owners, test engineers, or customers (via L3 or L4 Support).

How-to Manage Hardware Certifications

Various certifications are applied for in the development of products. This guide covers the ten activities of the general certification flow, and includes specific information regarding marine certifications, certifications for hazardous areas, certification affecting manufacturers, and the order of certification applications.

How-to Map Lifecycle Components to Branded Product Release

This guide describes the approach for mapping the lifecycle components derived from the technology product releases, to the branded products (800xA, Symphony Plus, etc.). It also covers how to gather the data and share relevant ECCN-related information with the product classification team.

How-to Perform Binary Composition Analysis with BDBA

Binary composition analysis is a method used to examine the components inside binary files to detect and manage security risks. This guide describes how to perform such analysis with Black Duck Binary Analysis (BDBA).

How-to Perform Threat Modeling

Threat modeling is the process of analyzing various business and technical requirements of a system identifying the potential threats, the mitigations of these threats, and documenting the vulnerabilities these threats have on the system.

How-to Setup a Team in ADO

Defining a team in Azure DevOps (ADO) allows the use of planning and visualization features, for example, the team backlog, sprints, capacity planning, boards, and team dashboard.

How-to Work with Epics

This guide describes how to handle epics in streams. It includes examples of epic descriptions and information about the epic definition, grooming, and change management.

How-to Work with Features

This guide describes how to handle features in streams. It includes examples of feature descriptions and information about the feature definition, grooming, and change management.

How-to Write and Review a Test Case in ADO

For a new epic, feature, or user story, there may be a need to write new test cases or modify existing test cases. The purpose of this guide is to provide hands-on support to the roles involved in writing, updating, or reviewing test cases of a product.

Specific Code Review Guideline for Control (Git)

This code review guideline is written for those in the Control organization working with Git and includes the functional safety related aspects to adhere to. The guideline is directed to both source code level as well as feature level.