Northridge Management Services

Contact Us



Services
    Software Validation

    Process Validation

    Risk Management

    Quality Systems

    Process Improvement

    Training

    Technical Writing

    Interim Management

    Auditing
Blog
Technical Writing Tip of the Month - Using Paragraphs
20th July 2020

Technical Writing Tip of the Month - Key Elements of a Good Document
20th July 2020

Technical Writing Tip of the Month - Understand your Audience
20th July 2020

more...


Technical Writing Tip of the Month - Key Elements of a Good Document

Technical Writing Tip - Key Elements of a Good Technical Document

Written by John Lafferty
Read Time: 2 minutes

A good document is one that gives a clear message which all of the intended readers can easily understand.

Key elements of a Technical Document:

• The document must convey the most important message and direct the reader to any relevant detail. Remember, the most important message will be defined by the actions that you want the readers to take upon reading the document.

• In order to readily convey the message to the reader, the document must contain a summary that is a microcosm of the document as a whole.

• The introduction must explain why the reader is being asked to read the document.

• The document should be self-explanatory i.e. the reader should be able to understand it without needing to read anything else.

• The message should be conveyed using the minimum number of words; good use of graphics is essential for this.

• The document should hold the reader’s attention and consistently meet their expectations without any surprises.

• It almost goes without saying; that the document should be well structured, grammatically correct and free from typos.

Technical Writing Skills Training Course 

Northridge Quality & Validation and our training partners, SQT Training are running a comprehensive training course on Technical Writing Skills. Note: This course will be delivered via a Virtual Classroom (not in person) 
 
Course Title: Technical Writing Skills 

Course Date and Booking: The next course will be delivered by Virtual Classroom delivery on 24th June 2020 so that you can attend without leaving your home or office. Course booking and details can be found on the SQT Training website.  

Course Content: Our structured, practical programme will help you to identify the key message you need to deliver in your written document and to deliver it clearly and concisely in a way that will ensure it is understood.

John Lafferty - Course Tutor

John Lafferty is Technical Writing Skills course tutor at SQT Training Ltd. He also delivers courses in areas such as Process Validation, Software Validation and Risk Management for Medical Devices. John runs a Quality Management Consultancy, Northridge Quality and Validation Services, specialising in the area of Medical Device and Pharmaceutical Quality Systems.



Comments:


Post A Comment:

Name:
Email:
Comment:*




 

    Home - Services - Clients - News - About Us - Contact Us