Skip to main content

Standard Document Update Template

This guideline describes the Document Update work item type and the custom standard fields used in its template. For a more general picture of the standard work item template change process in Azure DevOps, see ADO standard work item template change management process.

Overview​

The Document Update work item is an ABB specific work item used to track changes on documents under formal change management e.g project steering document or a product document.

Document Updates can also be used to manage changes to any document stored in the Document Management System to facilitate more controlled handling of documents. The Document Update work item is used for both new documents and for updates in previously approved ones. One work item is used to handle updates in one document. The request to change a document could come from a change in requirement, an impact analysis or updates needed due to errors or modifications in functionality.

The Document Update work item can be used as a task and linked to a user story or bug. If an error is found in a manual or other customer documentation, a bug, and not a document update, should be created.

Review Details​

Review Details
When the document is reviewed and approved, add the names of the reviewers if review type is ‘Minor’, or a reference to full review record if review type is ‘Full’.

Document Data​

Document data

Document Id​

The id of the document as the identifier.

Rep. Doc. Revision​

The current revision of the document to be updated. "New", if it is a new document.

Document Type​

The type of the document to be updated. The document type should be the same as in OnePCP DMS.

Changed Doc. Revision​

The revision of the document after update.

Review Decisions​

Review Decisions

Review Type​

The type of review needed for the update. Review type is decided by the CCB.

Different types:

  • Full

  • Minor - The change is an enhancement or an error correction with minor impact on design, no impact on safety or safety concept, and no consequences for any other components (hardware related) or modules (software related). A minor change is only possible when no new requirement or no change of an existing requirement has to be done. A minor review is sufficient if the previous statements are fulfilled, unless:

    • It is more than 2 years since the last approved full review was done
    • The document has been approved 3 times without a full review.

  • Not Applicable

Review Date​

Date of the review meeting.

Owner: Configuration Management Team