The description of a Management System Documentation can be split into a 4 level hierarchy:
Level 1 – Apex Manual (Policy - The why part of the system)
This level is generally structured aligning to its adopted standard / specification and provides an overview of the company, products and services; The frame agreement to comply with applicable requirements of standards, statutes and regulatory requirements; policy; system scope; exclusions; organization and responsibilities; sequence and interaction of processes; refernce to documented procedures.
Level 2 - Management Procedures / Processes (Sequence and interaction - The who, what, when, where part of a system)
Describes the who, what when and where of processes and procedures and interdepartmental controls that address the standard / specification requirements; may be in the sequence of the standard / specification order or process order; Generally this level provides reference to lower-level documentation.
Any management system mandates six specific procedures that addresses the management approach towards Document Control, Record Control, Internal Audit, Non conformity handling, Corrective action and Preventive action as specified in the adopted standards
Level 3 – Work Instructions (To do - how)
This level of documentation explains details of specific tasks or activities: the how of performing a specific task. This level may include FMEAs, control plans, quality plans, work instructions, drawings, layouts, flowcharts, workmanship standards, signages, product specifications, machine manuals,check lists etc.
Level 4 – Other Documents (Show me - For Evidence, For data gathering to analyse, improve)
Forms, tags, labels, and other documents that prompt the recording of evidence (per levels 1,2 and 3 documentation) of compliance to requirements. Records may be mandatory as specified in standards / specifications or implied for each management procedure requirements.
However, when an organization chooses to include documentation, it should write the documentation based on the defined competency levels for that job. There will be situations when other people who perform the job in the absence of the experienced person, and they might need more documentation, even though they are competent to do the work.
This aspect has to be considered in the documentation. Documents must be available at the point of use and must be accessible to the user.
Also a combination of texts, charts, diagrams, colour codes etc., may provide ease of using a document. They will have to be considered in the way documentation is done.
It is very important that the documents are written in languages that are understandable by the persons who perform the task/ work. When displayed the location, font size, colour scheme etc., must be effective end ergonomically appropriate to the user.