Concept#
Documentation Management Concept
|
status: valid
|
||||
In this section a concept for the documentation management will be discussed. Inputs for this concepts are mainly the requirements of ISO26262 “Part 2: Management of functional safety” and “Part 8: Supporting processes”.
Key concept#
The Documentation Management Plan should define the strategy to manage the identified documentations in an effective and repeatable way for the project life cycle.
Inputs#
Stakeholders for the documentation work products?
What tooling do we need?
Which guidance for the work products do we have?
Stakeholders#
-
contributing documents
-
contributing and approving documents
Project Lead (rl__project_lead)
planning and status reporting of work products and their documentation for the platform
Module Lead (rl__project_lead)
planning and status reporting of work products and their documentation for modules
Safety Manager (rl__safety_manager)
wants to know when the safety related documents are ready for a release
wants to know who was the author and approver of a document in case of safety issues
Security Manager (rl__security_manager)
wants to know when the security related documents are ready for a release
wants to know who was the author and approver of a document in case of security issues
Quality Manager (rl__quality_manager)
wants to know when the quality related documents are ready for a release
wants to know who was the author and approver of a document in case of quality issues
Document Management Tooling#
For the document attributes to be manually set, sphinx-needs will be used.
For the versioning and version history github is used.
For the automated attributes additional tooling is created (see Document Management Process Requirements)
For the scheduling and tracking of the documentation GitHub issues will be used.
Guidance#
The document management guideline can be found here Documentation (gd_guidl__documentation).