The aim of this programme is to help attendees create better quality technical documents in an organised and efficient manner. It will give those new to the topic an appreciation of how to approach the task professionally whilst those with more experience will be able to refresh and refine their skills.
The programme comprises three complementary one-day modules:
The programme presents a structured methodology for creating technical documents and provides a range of practical techniques that help delegates put principles into practice. Although not essential, it is strongly advised that delegates for modules 2 and 3 have already attended module 1, or another equivalent course.
Note: the content of each module as shown here is purely indicative and can be adapted to suit your particular requirements.
This course will:
Explain the qualities and benefits of well written technical documents
Present a structured approach for producing technical documents
Review the essential skills of effective technical writing
Demonstrate practical methods to help create better documents
Provide tools and techniques for specification and report writing
Review how technical documents should be issued and controlled
Note: the content of each module as shown here is purely indicative and can be adapted to suit your particular requirements.
Module 1: Essential skills for technical writers
1 Introduction to the programme
Aims and objectives of the module
Introductions and interests of participants
2 Creating effective technical documents
What is technical writing? how does it differ from other writing?
Key qualities of an effective technical document
Communication essentials and the challenges faced by technical writers
The lessons of experience: how the best writers write
The five key steps : prepare - organise - write - edit - release (POWER)
3 Preparing to write
Defining the document aims and objectives; choosing the title
Understanding technical readers and their needs
Getting organised; planning and managing the process
Integrating technical and commercial elements
The role of intellectual property rights (IPR), eg, copyright
4 Organising the content
The vital role of structure in technical documents
Deciding what to include and how to organise the information
Categorising information: introductory, key and supporting
Tools and techniques for scoping and structuring the document
Creating and using document templates - pro's and con's
5 Writing the document
Avoiding 'blinding them with science': the qualities of clear writing
Problem words and words that confuse; building and using a glossary
Using sentence structure and punctuation to best effect
Understanding the impact of style, format and appearance
Avoiding common causes of ambiguity; being concise and ensuring clarity
Using diagrams and other graphics; avoiding potential pitfalls
6 Editing and releasing the document
Why editing is difficult; developing a personal editing strategy
Some useful editing tools and techniques
Key requirements for document issue and control
Module 2: Creating better specifications
1 Introduction
Aims and objectives of the day
Introductions and interests of participants
The 'POWER' writing process for specifications
2 Creating better specifications
The role and characteristics of an effective specification
Specifications and contracts; the legal role of specifications
Deciding how to specify; understanding functional and design requirements
Developing the specification design; applying the principles of BS 7373
Getting organised: the key stages in compiling an effective specification
3 Preparing to write a specification
Defining the scope of the specification; deciding what to include and what not