GDP DM

Good Documentation Practice and Document Management

(This is not the official source, only a unverified copy of what is defined in the Execution and Quality Plan)

General good documentation practice rules

All documents must have a reference to the source requirement. All documents must be listed in the overall document list. All documents have a defined integer version. All documents must be numbered in the format Page x of n All tables, figures and pictures in documents must have a footnote. Abbreviations can be listed in documents, but this is not a must if the abbreviation is common knowledge (i.e. ISO). Duplicate information must be avoided with great care.

Location

The primary location of finalized documents is the GitHub repository. The location is defined in the document list which resides in the root directory.

Drafts should be saved daily in the repository as well (use the folder 999_Drafts in the active project phase). Documents are separated according to the phase the project is in. Further description of the phases will be provided as a separate chapter in this document.

Template

For text documents and coversheets for other files (drawings, etc.) the current pages template shall be used. It shall reside on in repository in the folder 990_templates. Coversheets must contain a reference to the document that is attached to them. A template for this shall be available in the drafts folder of the repository.