Technical Writing - Help Training Supervisors in the Basics

J
#1
One of my tasks is Document control and I am trying to work with our Supervisors and managers to get things properly documented and up to date.
Currently, we tend to ask the supervisor to write things out and then we try to turn this into a controlled document.
Of course this process has a lot of snags (and frustration) when we have to go back and ask questions, get clarifications etc.

I've started writing down some brief "tips" that might be useful for the management people to know and was thinking about making this into a PPT that we could run our management folks through.

Of course I don't expect them to become technical writers. (Hey I need my job.:D) I just think that it would be useful for them to know what kinds of things we look for in a procedure, instruction etc.

Some points that I have touched on so far are things like: keeping it simple, choosing the right terms (shall or should etc), choosing the right format (flow, bullet, etc) advantages of using "white space".....things like that.

Anyway --------

Then I thought of the good ole Cove and wondered if any of you folks have done anything like this...have any tips, outlines, anything that might be useful.
Or - should I forget this idea and just keep slugging forward the way I have been.

Thanks for any help

James
 
Elsmar Forum Sponsor

John Broomfield

Leader
Super Moderator
#2
Re: Technical writing - hel training supervisors in the basics

One of my tasks is Document control and I am trying to work with our Supervisors and managers to get things properly documented and up to date.
Currently, we tend to ask the supervisor to write things out and then we try to turn this into a controlled document.
Of course this process has a lot of snags (and frustration) when we have to go back and ask questions, get clarifications etc.

I've started writing down some brief "tips" that might be useful for the management people to know and was thinking about making this into a PPT that we could run our management folks through.

Of course I don't expect them to become technical writers. (Hey I need my job.:D) I just think that it would be useful for them to know what kinds of things we look for in a procedure, instruction etc.

Some points that I have touched on so far are things like: keeping it simple, choosing the right terms (shall or should etc), choosing the right format (flow, bullet, etc) advantages of using "white space".....things like that.

Anyway --------

Then I thought of the good ole Cove and wondered if any of you folks have done anything like this...have any tips, outlines, anything that might be useful.
Or - should I forget this idea and just keep slugging forward the way I have been.

Thanks for any help

James
James,

Document what is instead of what should or shall be.

This encourages managers/process owners to focus on the process (aka the work flow).

Define the process objective or the reason for doing the work.

Then flowchart the process as it is to describe who does what to fulfill the process objective (swimlane format works best) instead of trying to write good prose.

Test the flowcharted procedure for uniformity of understanding by its users instead of the quality of writing.

If the process does not exist then design the process but engage the process team members in analyzing how the process actually works and what needs to go into its flowcharted procedure...

...and any supporting documented information such as photographs, video clips and cue cards.

John
 

Wes Bucey

Prophet of Profit
#3
I write a lot. (surprise!)

Different types of documents require different, individualized approaches.

A work instruction really needs two levels of documentation. The high-level (for experienced workers) is essentially a checklist to remind the experienced worker to perform the steps in order and not leave any out.

The basic level is more detailed. Think of this level as for the new worker who has zero prior knowledge of the tools, instruments, materials, and needs to be able to produce the product without an experienced hand to catch mistakes. Thus, this level might include sketches, diagrams, photos, videos, maybe even a "gold standard" model of the product to compare against his effort.

In general use, the document open at the work station would probably be the high-level one, BUT the basic one would be readily available in the drawer if the need might arise. Workers need to know BOTH levels exist and are available.

The supervisor needs to be aware of the :ca: aspect of documentation - that it should include the exceptions as well as the routine.

A purchase order is a document. If we order a commodity, we can give a generic description (1,000 pieces 2 X 4 pine lumber 8 feet long.) If we order a custom product, we need to be much more specific and precise in the description (1,000 pieces 304C stainless steel shafts, 0.500 inch diameter (+/- 0.005 tolerance, Ra 16 microinch), 6.000 inch length (+/- 0.005 tolerance, plus a straightness callout) all accompanied by an engineering drawing properly notated with G D & T per ANSI Y14.5 M.

A contract for building a multimillion dollar jet will probably be more detailed and specific than one for a fifty gallon barrel of cutting fluid for the machine shop.
 
P

PaulJSmith

#4
Re: Technical writing - hel training supervisors in the basics

Document what is instead of what should or shall be.
Oh, that we could get people to understand the simple genius of this basic concept...

That said, it's always helpful to educate your coworkers. Nothing wrong with the idea of a PPT to aid in that. Show them some examples of as-submitted documents vs your edited versions. Give them a basic understanding of what you'd like to see, and tell them why this is helpful.
 
J
#7
Great Stuff you guys.

Wes - you hit on an excellent point about getting folks to recognize the :ca: aspect of these things. We've all heard the line "nobody told me that". :rolleyes::notme:
Good documents and training cure that one.

John - Great bullet points to work from - and that's the kind of thing I'm hoping to develop.

J0anne and Pancho, thanks for the links. Good stuff there. :agree1:

James
 
Thread starter Similar threads Forum Replies Date
V Where to add SOP of writing a Technical File in ISO 13485? ISO 13485:2016 - Medical Device Quality Management Systems 1
Q Improving Technical Writing skills for CAPA Nonconformance and Corrective Action 7
Y EU MDR Technical Documentation - Defined Review EU Medical Device Regulations 1
E Discussion: How do you split up your Technical Documentation? EU Medical Device Regulations 4
B Technical Documentation for a medical device accessory Medical Device and FDA Regulations and Standards News 6
S Assembling technical file for a medical device ISO 13485:2016 - Medical Device Quality Management Systems 1
I Request for information regarding remote medical monitoring software (its technical documentation and the IUD system) IEC 62304 - Medical Device Software Life Cycle Processes 2
G Technical documentation for UKCA UK Medical Device Regulations 2
A Technical Documentation => Responsibilities when signing documents ISO 13485:2016 - Medical Device Quality Management Systems 7
A Update of Technical Documentation EU Medical Device Regulations 3
G Similarities between format of technical file for CE and ASEAN common submission dossier template (CSDT) CE Marking (Conformité Européene) / CB Scheme 2
V How many hrs does it take to create a Technical File (TD)? EU Medical Device Regulations 4
A Updating Technical Documentation regularly => Leaner Release Advice EU Medical Device Regulations 2
P Updates to Technical Documentation EU Medical Device Regulations 7
Q Structure Technical File for a system EU Medical Device Regulations 0
S Documents belonging to Technical documentation to be stored in one file or spread in the QM system? EU Medical Device Regulations 9
Fjalar ISO 20417:2021: Technical Data (6.6.4 c) Other Medical Device Related Standards 0
L ISO/IEC 20000-6 Technical Areas IT (Information Technology) Service Management 2
D Technical Standard aggregator company suggestions AS9100, IAQG, NADCAP and Aerospace related Standards and Requirements 2
S Biggest issues when producing MDR compliant Technical Files / DD EU Medical Device Regulations 4
J How many hours for a NB to review Technical Documentation? EU Medical Device Regulations 6
J Technical Documentation as per MDR / subpoint 6.1 EU Medical Device Regulations 3
B UKRP to what level should you audit Class I Technical Documentation? UK Medical Device Regulations 0
A Technical documentation ce marking pippete tips CE Marking (Conformité Européene) / CB Scheme 0
B MDR Technical Structure EU Medical Device Regulations 3
S Medical Device - Technical Documentation structure EU Medical Device Regulations 1
LostLouie Archived Specifications and Drawings for Medical Device Technical Files EU Medical Device Regulations 4
D Notified Bodies - ISO 13485 & MDR Technical Files ISO 13485:2016 - Medical Device Quality Management Systems 3
I "Usability" for technical documentation EU Medical Device Regulations 1
E Technical documentation for IVDD General/ other CE Marking (Conformité Européene) / CB Scheme 3
C European Technical File for registration in Australia CE Marking (Conformité Européene) / CB Scheme 5
K Technical file for MHRA - looking for assistance with self declaration Class I device CE Marking (Conformité Européene) / CB Scheme 8
H MD Technical Documentation and SALES possibility EU Medical Device Regulations 0
O Soft and technical skills for a VP of Quality Career and Occupation Discussions 1
A CE-IVD Technical File with Multiple IFUs EU Medical Device Regulations 5
A DMDIV-Variants : definition and technical documentation CE Marking (Conformité Européene) / CB Scheme 4
M Office and manufacturing site relocation effect on Device Technical File CE Marking (Conformité Européene) / CB Scheme 2
R MDR & depth of technical files review by NB's EU Medical Device Regulations 18
J Saudi Arabia Technical File Requirements Other Medical Device Regulations World-Wide 1
P MDR/IVDR Annex III - Technical documentation on PMS EU Medical Device Regulations 2
DuncanGibbons Technical Data Package vs Digital Product Definition APQP and PPAP 0
D Hospital Decontamination and the MDR - Technical Files, UDI and PMS EU Medical Device Regulations 3
F Software as a Medical Device (SaMD) Technical File Requirements Manufacturing and Related Processes 6
Al Rosen Technical File - Updating Applied Standards EU Medical Device Regulations 4
M What to be careful about/focus on when doing a Technical File review EU Medical Device Regulations 4
Watchcat Anyone had an MDR technical file review/audit yet? EU Medical Device Regulations 13
G Same intended use devices - Technical file EU Medical Device Regulations 5
I Maintaining Technical Documentation under MDD and MDR EU Medical Device Regulations 1
M Basic UDI and technical documentation EU Medical Device Regulations 8
B Clause 5.1.12 of Technical Standard IEC 62304/A1 IEC 62304 - Medical Device Software Life Cycle Processes 5

Similar threads

Top Bottom