Technical Writing Skills

Produce high quality technical documents, reports, manuals and guides which are clearly written, well presented and easy to read, Every piece of information that crosses your desk competes for your attention. Which one wins? The one that delivers its message with impact.

Writing technical reports does not come easily to everyone. Many of us agonise over what to include, how to present information and even how to get started. But it is important to get it right so that your reports are clear, concise and consistent. You need clearly defined outcomes of what your writing must deliver, who your readers are and how to present the information in the most useable way. This course will systematically take you through the planning, structuring, writing, checking and presentation stages of a project.

Course Objectives

In just 2 days, you will be shown the proven techniques of technical writing that will add that special ingredient of success to the documentation you produce. You will be given a methodology that will show you where and how to start your documentation project; and will guide you through the planning, researching, writing, proofing and editing process so that you’ll finish with quality piece of writing that reaches it audience and achieves its purpose.

This workshop will ensure your messages are stronger, more effective and memorable, creating an impact with instant and measurable success every time you write.

Teaching Methods

Benefit from strictly limited numbers. This intensive workshop is practical, business orientated and highly interactive. It is designed to help you structure and produce clear, easy-to-use documentation. Realistic syndicate exercises will be used throughout the 2 days which will enable you to acquire new skills and techniques for writing and presentation.

Bring along samples of your reports or documents to be discussed with your presenter.

 

Who should attend

If you are responsible for writing or editing technical material such as user manuals, staff instructions, procedure manuals, reference manuals or training manuals, then this workshop is for you. It os specifically designed for:

  • Technical personnel
  • Project managers
  • Training Specialists
  • General managers
  • technical professionals
  • Premises managers
  • Sales personnel
  • Building managers
  • Facilities managers
  • IT personnel
  • Publications managers
  • research officers
  • Quality managers
  • Documentation writers

How you and your organisation willl benefit

Effective communication is key to success - never more so than in technical environments where abbreviations, acronyms and technical jargon can confuse, leading to ambiguity, inefficiency, rework - and even failure. This workshop will show how to write technical documents in clear, unambiguous and readable language.

Programme

  • Introduction

    Why technical reports are different
    What’s in it for me?
    Setting objectives
    Targeting the audience

  • Collecting Information

    Research techniques
    Processing of documents relevant to the company and its industry
    Organising information

  • Reports and Structure

    Research reports and persuasive reports
    Position
    Issues
    Possibilities
    Recommendations

  • Language Style

    Use of plain English
    General approach
    Phrasing and sentences
    Use of words

  • Language Mechanics

    Vocabulary
    Technical grammar
    Spelling
    Abbreviations
    Punctuation
    Golden rules
    Bibliography

  • Layout and Format

  • Use of Appendices

    Use of diagrams, graphs, tables and chart
    Illustrations

  • Documentation

    How to review documents
    Proofreading
    Tools
    Checklist

  • Psychology of Persuasion

    Creating empathy with the audience
    Hints for persuasion
    Clarity in documentation
    Types of layout
    Putting the report in context -topping and tailing
    Executive summaries
    Typographics
    References

Workshop Leader

Andrew Hiles

 

 

Books by Kingswell Consultants

Books on Service Management

Hiles, A. N. The Complete Guide to IT Service Level Agreements, Matching Service Quality to Business Needs.. ISBN 0-9641648-2-5 published by Rothstein Associates Inc.  The standard work on IT Service Level Agreements.

Hiles, A. N. E-Business Service Level Agreements: Strategies for ISPs, ASPs, *SPs and CLECS.  Published by Rothstein Associates Inc.  The first book to deal specifically with e-commerce Service Level Agreements.

Hiles, A. N. Service Level Agreements, Winning a Competitive Edge for Supply and Support Services.  ISBN 0-9641648-4-1published by Rothstein Associates Inc. This book applies Service Level Agreements to services other than IT. Real case studies and example SLAs are provided ranging from Human Resources, Logistics, through Training, Livestock Handling, Logistics and Field Service Engineering.

Hiles A.N. and Gunn, Dr. Y. Creating a Customer-Focused Help Desk: How to Win and Keep Your Customers. Published by Rothstein Associates Inc. ISBN 0-9641648-6-8 This book has the support of the Help Desk Institute www.helpdeskinst.com

Books on Business Continuity

Hiles A.N. Business Continuity Management: Best Practice. Published by Rothstein Associates Inc. ISBN 0-9641648-3-3.  This book explicitly covers all the ten areas of business continuity competence required for membership of the Disaster Recovery Institute International (DRII) and the Business Continuity Institute (BCI).

Hiles A.N. Enterprise Risk Assessment & Business Impact Analysis – Best Practices ISBN 1-931332-12-6 Published by Rothstein Associates Inc. Covers many techniques and methods of risk and impact assessment with detailed examples and checklists.

e-Publication. Kingswell books on Business Continuity, Service Level Agreements and  Help Desk Management will shortly be available by page download in conjunction with Rothstein Associates Inc and Books24x7.com.

New and updated books. Existing  books Business Continuity Management – Best Practice and IT Service Level Agreements have been extensively updated. See our products page or visit www.rothstein.com .

All the above books can be obtained from:

Rothstein Associates Inc.
4 Arapaho Road
Brookfield
Connecticut
0608-3104 USA

www.rothstein.com

e-mail pjr@rothstein.com

Telephone: USA: 1-888-ROTHSTEIN
Worldwide: +1 203 740 7400

Hiles A.N. Guide to Risk Management. Published by the Institute of Chartered Accountants of England and Wales.

Hiles A.N. and Barnes, P. (Editor and main contributor) The Definitive Handbook of Business Continuity Management, John Wiley & Sons, 1999, ISBN 0 471 98622 4.

Hiles, A.N. (contributor), Croner’s Purchasing and Supply Guide to I.T., 1994, ISBN 1 85524 271 0

Hiles, A.N. (contributor), Guide to Business Continuity Management, 1999, for the Confederation of British Industry by Caspian Publishing

Hiles A.N. (contributor) Business Continuity Management, 2000, Institute of Directors / Department of Trade & Industry.

 

Kingswell © 2005