This is a ready-to-use style guide. Replace every <<FILL: ...>> placeholder with your own specifics and adapt the banned-phrase and glossary tables to your own quality system’s vocabulary. This is educational guidance to adapt and verify, not legal or regulatory advice.
Document control header
| Field | Entry |
|---|---|
| Document title | GxP Plain-Language and Terminology Style Guide |
| Document number | <<FILL: DOC-ID, e.g. QA-STY-001>> |
| Version | <<FILL: version>> |
| Owner | <<FILL: role, e.g. Head of Quality Assurance>> |
1. Purpose
This guideline sets the plain-language and terminology standard for GxP records at <<FILL: COMPANY NAME>>, so that one document has one meaning for every reader, at every site, in every language it is read or translated into. It gives authors and reviewers a shared vocabulary and a banned-phrase reference rather than leaving tone to individual judgment.
2. Scope
This guideline applies to the written content of GxP protocols, reports, deviation records, investigation narratives, CAPA records, and quality procedures produced at the sites named in the header, including content that will be translated or read by staff at a different site than the one that drafted it. It does not set document numbering or approval routing, which are governed by <<FILL: SOP-ID for document authoring and control>>.
3. Plain-language statements
- One idea per sentence. A sentence carrying two or three subordinate clauses is harder to verify and, if translated, is more likely to drift in meaning. Split it.
- Active voice for attribution, passive voice only where the actor is already defined. In an event narrative, name the role or person. In a procedure step, the actor may be implied by the responsibilities section.
- Quantify instead of describing. A number, a limit, a duration, or an identifier replaces an adjective. “High” becomes a value against a stated limit; “recently” becomes a date and time.
- Define every acronym at first use in the document, even one your own site treats as universal. A term obvious at one site is often unclear at another.
- Avoid idiom and culturally specific reference. Phrases such as “ballpark figure,” “across the board,” or “touch base” do not translate literally, and a literal translation can invert the intended meaning.
- Keep pronoun references close to their antecedent. If “this,” “it,” or “the same” could refer to more than one thing mentioned in the last two sentences, name the thing directly instead.
- Write dates, units, and numbers so they cannot be misread across regions. Use an unambiguous date format (for example DD-MMM-YYYY) and spell out the unit at first use.
- State the requirement and the departure before any conclusion. Facts precede interpretation in every document type; interpretation is clearly labeled as analysis or assessment.
4. Banned phrases and their stronger replacements
| Banned or vague phrase | Why it is banned | Use instead |
|---|---|---|
| ”minor,” “slight,” “just,” “only,” “isolated” (ahead of evidence) | Minimizes an outcome before the evidence supports the characterization | State the fact and the quantified scope; let the criticality assessment carry the rating |
| ”no impact,” “no cause for concern” (before investigation) | States a conclusion before any evidence has been gathered | Write this only in the impact assessment, after the evidence is cited |
| ”human error,” “operator error” (as a standalone root cause) | Names an individual’s action, not a system cause; explains nothing | State why the failure was possible: the missing check, the ambiguous instruction, the design gap |
| ”appropriate action was taken” | Not falsifiable; a reader cannot check whether the action was appropriate or even determine what it was | Name the specific action and the time it was taken |
| ”the issue was addressed” | Vague about whether the issue was fixed, worked around, or merely noted | State the specific corrective action and the evidence it was completed |
| ”as needed,” “as required,” “periodically” | No defined trigger or frequency; unauditable | State the trigger or the exact frequency |
| ”should have,” “could have” | Speculative and unfalsifiable | Report only what the evidence shows did or did not happen |
| ”seems to indicate,” “appears to” | Hedges a conclusion instead of showing the reasoning | State the evidence, then the conclusion it supports |
| ”the current SOP,” “the attached form” (no number given) | Resolves to the wrong document once either one is revised | Cite the document number and version |
| ”updated for clarity” (as a revision history entry) | Tells a future reader nothing about what changed or why | Describe the specific change and its trigger (a deviation, an audit finding, a process change) |
5. Starter terminology glossary
Use one term for one concept throughout a document set. This starter list covers terms that commonly drift; extend it with your own site- or system-specific vocabulary.
| Concept | Use this term | Avoid these variants |
|---|---|---|
| A departure from an approved instruction or specification | Deviation | Non-conformance, exception, incident (unless your quality system formally defines these as distinct categories) |
| The document that authorizes a planned activity in advance | Protocol | Plan, script, test plan (unless your system formally distinguishes them) |
| The person who performed the recorded action | Analyst / operator / technician (use the role that actually applies) | “The user,” “someone,” or an unnamed actor |
| The systemic reason a failure was possible | Root cause | ”The problem,” “the reason,” used loosely for either the symptom or the cause |
| A corrective action’s confirmed outcome | Effective / not effective | ”Closed,” used as if it meant the same thing as effective |
| The document version currently authorized for use | Effective version, with its number | ”Current,” “latest,” “final” used without a version reference |
6. Roles
| Role | Responsibility under this guideline |
|---|---|
| Author | Applies the plain-language statements and the banned-phrase table while drafting. |
| Terminology / style owner (multi-author or multi-site documents) | Owns the glossary for that document, resolves inconsistent terms across sections and authors, confirms translated content preserves the original meaning. |
| Independent reviewer | Checks the draft against sections 3 and 4 before it reaches its final approver. |
| Quality Assurance | Owns this guideline, updates the banned-phrase and glossary tables as new patterns are identified, and resolves disputes over terminology. |
7. Compliance and exceptions
Authors are expected to apply this guideline to every GxP document in scope. Where a specific banned phrase is genuinely accurate and evidenced (for example, “isolated” after an impact assessment has confirmed a single, non-recurring instance), its use after the supporting evidence is not a violation; the guideline prohibits the phrase appearing ahead of the evidence, not the word itself. Any dispute over whether a use is compliant is resolved by Quality Assurance, and any recurring pattern of exceptions is fed back into section 4 as a documented update rather than left as an informal understanding.
8. References
FDA guidance, Data Integrity and Compliance With Drug CGMP: Questions and Answers (December 2018), on objective, evidence-based recordkeeping. 21 CFR 211.192 (thorough investigation of discrepancies and failures), which the root cause and impact-assessment language rules in section 4 are written to support. EudraLex Volume 4, GMP Chapter 4 (Documentation), for the underlying documentation-quality expectation this style guide operationalizes.
Confirm the current version of each reference before you rely on it.
Filled specimen
The following shows a short passage rewritten using this guideline, so you can see the standard applied end to end. The company, system, and numbers are illustrative.
Before: “There was a bit of an issue with the fill weights on the line, but it was pretty minor and the team dealt with it, so there shouldn’t be any impact. Operator error was probably the cause and retraining has been done.”
After, applying sections 3 and 4: “Batch record BR-3390 section 6.2 specifies a target fill weight of 50.0 g with a range of 48.0 to 52.0 g. On 20-Aug-2026, three consecutive units on Line 2 were recorded at 46.5 g, below the lower limit. The units were segregated at 11:20 and the batch was placed on hold pending investigation. Root cause: the checkweigher’s low-limit alarm threshold had been set to 45.0 g during the last calibration, outside the batch record’s approved range, so out-of-range units were not flagged until the next manual check. Corrective action: alarm threshold corrected to 48.0 g and the calibration procedure updated to pull the threshold from the current batch record specification rather than a fixed default.”
The rewrite states the requirement and the departure with numbers, names the containment action, and replaces “operator error, retraining done” with a system cause traceable to a specific calibration record.
Common inspection findings this guideline prevents
- Minimizing or reassuring language appearing in a record before any evidence supports it.
- “Operator error” or “human error” left standing as the final root cause with no systemic explanation.
- The same system, role, or event called by different names across sections of the same document set.
- A translated or localized record that no longer carries the same meaning as the approved source document.
- A revision history that reads “updated for clarity” with nothing a future reader can act on.
How to adapt this guideline
- Set your document number, owner, and version in the header.
- Extend the glossary in section 5 with your own site’s system names, role titles, and process terms, and keep it as a living reference updated by the terminology owner.
- Add site- or product-specific banned phrases to section 4 as your reviews identify recurring patterns.
- If your documents are routinely translated, pair this guideline with your translation vendor’s process so the glossary in section 5 is the source both the original author and the translator work from.
- Confirm every regulation in section 8 against the current published version before issue.