Procedure Document and Work Instruction Design Guide — From "Meeting Audits" to "Guiding Work" Document Revolution

Introduction

In a company's quality management system (QMS), work instructions (WI) and procedure documents serve as the "operation manuals" for the quality system—telling employees how to perform each process and how to follow each procedure. However, these documents often face two extremes: either they are as thick as a dictionary and no one reads them, or they are so rudimentary that they are just a single page and are not sufficient.

The root cause of this phenomenon lies in the fact that many companies treat "writing documents" as a task to "meet audits" rather than a tool to "guide work." Once the documents are written, they are shelved, and employees continue to rely on "oral traditions" to perform their tasks. This not only leads to a disconnect between the quality system and actual operations but also results in long training cycles for new employees and significant knowledge loss during job transitions.

A "good document" should have three characteristics: accuracy, conciseness, and usability. Accuracy means the document aligns with actual operations; conciseness means it covers all necessary points without being verbose; usability means employees can follow the document step-by-step without needing to consult a supervisor.

This article will systematically discuss the principles of designing procedure documents and work instructions, the methods for structuring and writing content, the techniques for designing record forms, and the entire lifecycle of document management, helping quality managers and engineers create documents that employees are willing to read, can follow, and will not lead to errors.

Basic Knowledge: Hierarchy and Structure of the Document System

The Four-Layer Pyramid of Quality Documentation

ISO 9001 and other standards typically divide quality documentation into four layers, forming a "pyramid" structure:

          ┌─────────────────┐
          │  Quality Manual  │  ← Strategic Layer: Quality Policy, Objectives, System Scope
          ├─────────────────┤
          │ Procedure Document │  ← Process Layer: Cross-departmental Process Definitions, Responsibility Allocation
          ├─────────────────┤
          │ Work Instruction  │  ← Operational Layer: Job Operation Standards, Process Parameters
          ├─────────────────┤
          │  Forms/Records    │  ← Evidence Layer: Records and Evidence of Execution
          └─────────────────┘

Quality Manual (A Layer): Describes the overall framework of the company's QMS, quality policy, and quality objectives. It is usually drafted by the quality department and approved by management. It generally does not cover specific operational details.

Procedure Document (B Layer): Defines cross-departmental business processes and clarifies "who does what, in what order." For example, the "Nonconforming Product Control Procedure" and the "Corrective and Preventive Action Control Procedure." The primary readers are middle-level managers.

Work Instruction (C Layer): Provides specific guidance for job-level operations, including steps, process parameters, and inspection standards. For example, the "SMT Mounting Machine Operation Procedures" and the "Incoming Quality Control (IQC) Work Instruction." The primary readers are frontline operators and inspectors.

Forms and Records (D Layer): Used to record the execution process and results, such as the "Patrol Inspection Record Form," "8D Report Template," and "Equipment Inspection Form." Forms are both execution tools and evidence of quality traceability.

What a Good Work Instruction Should Include

A standard work instruction is recommended to include the following elements:

Key Knowledge: Methods for Designing Procedure Documents and Forms

Step 1: Document Planning — Determining Which Documents Are Needed

Before starting to write documents, it is essential to determine the "skeleton" of the document system. The following steps are recommended for planning:

1. Process Mapping Draw a flowchart of the existing business processes and identify all nodes that require procedure documents or work instructions.

2. Quantity Estimation For a medium-sized manufacturing company (300～500 employees), the reference quantities for the document system are:

• Procedure documents: 20～40 (covering ISO standard requirements + company-specific processes)
• Work instructions: 100～500 (depending on the number of processes)
• Forms/record templates: 2～5 forms per procedure document

3. Priority Ranking Not all documents need to be written at once. Suggested priority levels:

• High priority: Documents directly related to customer qualification certification (must be reviewed during customer audits)
• Medium priority: Processes that directly impact product safety and quality
• Low priority: Back-end support processes (administration, IT, etc.)

4. Writing Division Documents should be written by the "users"—work instructions by process engineers but reviewed by operators; procedure documents by process owners but co-signed by relevant departments.

Step 2: Structure Design of Procedure Documents

A good procedure document is recommended to follow the standard structure below:

1. Purpose A single sentence explaining why this procedure is needed. For example, "To ensure that nonconforming products are effectively identified, isolated, reviewed, and disposed of, preventing their unintended use."

2. Scope Clearly define the product types, departments, or process ranges to which this procedure applies. For example, "Applies to nonconforming products discovered during production and those returned by customers."

3. Definitions and Abbreviations Explain the professional terms or abbreviations used in the procedure. For example, "NR (Nonconformance Report, 不合格报告), MRB (Material Review Board, 物料评审委员会)"

4. Responsibilities Clearly define the responsible departments/positions for each step. For example:

• Operator: Identify and isolate nonconforming products, fill out nonconformance labels
• Quality Engineer: Organize the review of nonconforming products
• Production Planner: Adjust production plans, handle nonconforming product inventory

5. Work Flow The core part of the procedure. It is recommended to use a flowchart + textual description for dual expression.

• The flowchart shows "what to do first, what to do next"
• The textual description supplements "how to do it, to what standard"

6. Related Documents List of other documents referenced in this procedure (other procedures, work instructions, forms).

7. Record List List of records generated by this procedure that need to be archived (form number, form name, retention period).

8. Flowchart (Appendix) Place the flowchart as an appendix at the end of the procedure document for independent reference.

Step 3: Writing Techniques for Work Instructions

Technique 1: Write in "Operator Language" Do not directly copy engineering terms into the document. Use vocabulary familiar to operators, and include diagrams when necessary. For example:

• ❌ "Use M8×20 hex head bolts to tighten the joint surface to 35±2 N·m torque"
• ✅ "Use 8 mm bolts, tighten to 35 torque (about the force needed to feel a slight resistance after turning)"

Technique 2: Fixed Position for Keywords Place important information in fixed positions to help operators quickly locate it. For example, place a "Key Parameters Box" in the upper right corner of each page of the WI, highlighting the 3～5 most important process parameters for that operation.

Technique 3: Prioritize Visualization Use diagrams instead of text and tables instead of sentences whenever possible. For example:

• Assembly guidance: Use exploded diagrams + arrow annotations, which are 10 times more effective than long text descriptions
• Inspection standards: Use "good/bad" comparison photos
• Operation steps: Use numbered lists + icons ( TOOL ? PPE ? CAUTION ⚠)

Technique 4: Control Document Length A single work instruction should be kept to 1～3 pages. If it exceeds 3 pages, consider splitting it or structuring it into sections. Operators do not have the patience to read long documents.

Technique 5: Visual Marking for Version Updates When updating versions, mark changes with vertical lines (|) or highlighted backgrounds to help operators quickly identify "what has changed" without reading the entire document.

Step 4: Methodology for Form Design

Forms are the "implementation tools" of documents—they are the carriers for recording the execution process and are also evidence of quality traceability. A good form design should follow these principles:

Principle 1: Form as Instruction The layout of the form itself should tell the filler "what to fill in which position." For example:

• Place "start time" in the upper left corner and "end time" in the upper right corner—implying to fill in the start time first, then the end time
• Use a gray background to mark fields "automatically generated by the system," reminding the filler not to manually fill them

Principle 2: Logical Field Design The order of fields should align with the actual operation sequence. For example, the fields in a patrol inspection record form should be: inspection time → inspection item → specification requirements → actual measurement → judgment result → abnormal handling. Operators can fill in each item in sequence.

Principle 3: Standardized Form Header All forms should have a unified form header, including:

• Form number (unique number for easy retrieval and archiving)
• Form name
• Version number/effective date
• Page number (Page X / Total Y pages)

Principle 4: Adequate Space for Filling A too-tight form can lead to fillers "skipping" and missing key information. Generally, the height of handwritten fields should be ≥ 10mm, and the height of text description areas should be ≥ 20mm.

Principle 5: Automatic Calculation Fields For fields that require calculation (such as averages, pass rates), if using Excel or system forms, set up automatic calculation formulas to reduce manual calculation errors.

Step 5: Document Approval, Release, and Updates

Suggested Approval Process:

Release Methods:

• Paper documents: Controlled with stamps, distributed to controlled workstations
• Electronic documents: Use a Document Management System (DMS) or Quality Management System (QMS) for unified control
• Important Note: Only controlled versions should be placed on-site, and obsolete versions should be promptly recovered or destroyed (retain one archived copy for traceability)

Update Triggers:

• Design/Process Changes: Related documents must be updated simultaneously
• Tool/Equipment Replacement: Update the WI when operation steps change
• Quality Issue Feedback: Update documents from a root cause control perspective
• Regular Review: Conduct a systematic review of all documents annually

Practical Methods: Standard Templates for Document Writing

Work Instruction Template (Simplified Version)

╔══════════════════════════════════════════════╗
║         Work Instruction (WI)               ║
╠══════════════════════════════════════════════╣
║ File Number: WI-2026-XXX   Version: A.1   Effective: 2026/6/27 ║
╠══════════════════════════════════════════════╣
║ Process Name: ___________   Workstation: ___________  ║
║ Product/Part: ___________   Equipment: ___________  ║
╠══════════════════════════════════════════════╣
║ Pre-Operation Preparation:                             ║
║ □ PPE: ______  □ Tools: ______  □ Materials: ______  ║
║ □ Confirmation of incoming materials from the previous process: □ Conforming  □ Abnormality handled  ║
╠══════════════════════════════════════════════╣
║ Key Parameters:                                ║
║ ┌────────────┬────────┬────────┐              ║
║ │ Parameter Name │ Specification │ Control Method │              ║
║ ├────────────┼────────┼────────┤              ║
║ │            │        │        │              ║
║ └────────────┴────────┴────────┘              ║
╠══════════════════════════════════════════════╣
║ Operation Steps:                              ║
║ 1. ____  →  2. ____  →  3. ____  →  4. ____  ║
║ 5. ____  →  6. ____  →  7. ____  →  8. ____  ║
╠══════════════════════════════════════════════╣
║ Quality Standards (Conformity/Nonconformity Judgment): ║
║ ____________________________________________  ║
╠══════════════════════════════════════════════╣
║ Abnormal Handling:  ⚠ When an abnormality occurs: ① Isolate the product  ② Notify the team leader  ║
║           ③ Fill out the abnormality report  ④ Wait for handling             ║
╚══════════════════════════════════════════════╝

Procedure Document Template (Core Structure)

1. Purpose
2. Scope
3. Definitions and Abbreviations
4. Responsibilities
5. Work Flow
   [Flowchart]
   [Textual description, step-by-step according to the process]
6. Related Documents
7. Record List
8. Appendix (Flowchart)

Form Design Verification Checklist

Each released form should be verified against the following questions:

• Are the form number, version number, and effective date complete?
• Is the field order consistent with the operation sequence?
• Is there sufficient space for filling?
• Are drop-down options / judgment standards clear (not leaving blank lines for employees to "write essays")?
• Are automatic calculation fields set with formulas or automatic calculation rules?
• Is a signature or approval required? (Mark the signature position)
• Are the archiving period and storage method annotated?

Pitfall Avoidance Guide

Pitfall 1: Document Content Does Not Match Actual Operations

Phenomenon: Procedure documents and process standards are beautifully written, but the actual operations of frontline employees deviate from the document content. Training sessions instruct employees to "follow the documents," but experienced employees privately teach new employees "this is how we actually do it."

Countermeasure: After writing the document, conduct a "document walkthrough" (Walkthrough)—the writer should go to the workstation with the document and have the operator follow the description step-by-step, making on-the-spot adjustments for any deviations. Only documents that have been confirmed through a Walkthrough should be approved and released.

Pitfall 2: Excessive Length and Poor Readability

Phenomenon: Work instructions are written like manuals—long paragraphs, no sections, no diagrams, no highlighted key points. Employees give up after flipping through a few pages.

Countermeasure: Set a "document length red line"—a single work instruction should not exceed 3 pages (up to 5 pages for particularly complex processes). Promote a culture of concise writing: if it can be said in one sentence, do not use two.

Pitfall 3: Uncontrolled Document Versions

Phenomenon: One version on the office computer, another version of the paper document hanging at the workstation, and an "updated but not withdrawn old version" still in use. Audits reveal significant differences.

Countermeasure: Establish a distribution and recovery ledger for documents. Each controlled paper document should be stamped with a "controlled number" and "version number." When updating: release new document → sign receipt → recover old document → destroy (except for archived copies for traceability).

Pitfall 4: Designer-Centric Form Design

Phenomenon: Form fields are arranged according to "system design convenience" or "quality engineer understanding" rather than the "operator filling" logic. As a result, operators have to pause and think about "what to fill in each field."

Countermeasure: Involve 2～3 operators in the form design review. Have operators simulate filling out the form to identify any unclear points. Adjust the field order and wording based on feedback.

Pitfall 5: Documents "Written and Forgotten"

Phenomenon: After documents are approved and released, no one proactively checks or updates them. Three years later, the content is severely outdated, but it is still the "current effective version."

Countermeasure: Establish an annual document review mechanism. At the end of each year, the document owner should review each document they are responsible for, confirming whether updates are needed. Documents that are not timely reviewed should be marked as "expired pending review" and cannot be used as controlled documents.

Summary

Procedure documents and work instructions are the "most practical" parts of a company's quality system. They directly determine whether employees follow the standards in their daily work and whether the quality system can move from "paper" to "the field."

Good document design requires the writer to always consider the "user's" perspective: Can the operator understand it? Is it easy to fill out? Can key information be found quickly? Documents that meet these criteria are truly effective on the workstation.

When promoting the document system, it is recommended to follow the roadmap of "from core to periphery, from urgent to non-urgent," first covering key processes and high-frequency flows, and continuously improving during operation. Most importantly, documents must align with actual operations—this is the lifeline of all quality system documents.

Knowledge code: 3.2.2

Version: v20260627

Author: Quality Think Tank Quality Think Tank is dedicated to providing systematic professional knowledge, methodologies, and practical tools for quality management practitioners, helping companies continuously improve their quality capabilities.