Document Management Process Requirements#

Document Types
status: valid
tags: done_automation, documentation_management

There are the following document types:

  • document

  • doc_tool

Note

The type “document” is the GENERIC type, which can be used for realizing concrete work products, with the exception of the tool verification report (which uses the “doc_tool” type). The “doc_tool” type is described in Process Requirements.

Note

Process documents are not documents realizing work products, types for that shall only used for process definition, as defined

  • gd_chklst

  • gd_guidl

  • gd_req

  • gd_temp

  • doc_concept

  • doc_getstrt

  • workproduct

  • workflow

  • role

Document attributes
status: valid
tags: manual_prio_1, documentation_management

Generic documents shall have the following mandatory manual attributes:

  • id

  • status

  • security

  • safety

  • realizes

The attribute “tags” is optional.

Compare also Documentation Template (gd_temp__documentation)

Document attribute: status
status: valid
tags: manual_prio_1, attribute, mandatory, documentation_management

Each document, shall have a status depending on the document lifecycle models below:

  • Model 1: VALID (e.g. for simple reports)

  • Model 2: DRAFT -> VALID (e.g. for plans)

  • Model 3: DRAFT-> VALID -> VALID(inspected) (e.g. for stakeholder requirements)

Compare Documentation (gd_guidl__documentation)

Document Author
status: valid
tags: prio_1_automation, documentation_management

The version management tool shall document and report (be able to show) the authorship of a document. I.e. for each change of a document the author of the changes is stored.

Document Reviewer
status: valid
tags: prio_1_automation, documentation_management

The version management tool shall document and report (be able to show) the reviewers of a document. I.e. for each change of a document the reviewers of the change are stored.

Document Approver
status: valid
tags: prio_1_automation, documentation_management

The version management tool shall document and report (be able to show) the approver of a document. I.e. for each change of a document the approver of the change is stored, which is usually the person with “write-rights” on the document approving the merge of a Pull Request (this may also be more than one person). Note that every approver is also reviewer.