2 Educators providing Book Writing courses in Bristol

This very practical session is designed to enable participants to improve the impact, clarity and accuracy of their reports. It focuses equally on the two key areas - structure and writing technique. This course will help participants: Scope reports based on objective and intended readership Write a structured report Use the Fog Index to ensure readability Write grammatically correct and well-punctuated text Review and edit their work. 1 Introduction Objectives and overview Introductions and personal aims 2 What makes a good report? Practical activity and feedback 3 Before you start The planning process and scoping a report Organising information Key report headings What goes where? Writing practice and review 4 Writing tips and techniques Clear English and use of language Grammar and sentence structure Refresher in punctuation Writing in the third person The Fog Index - and how to measure readability 5 Pulling it all together Reviewing and proofing 6 Review Summary of key learning points Action planning

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 Scoping techniques: scope maps, check lists, structured brainstorming The why/what/how pyramid; establishing and understanding requirements Clarifying priorities; separating needs and desires: the MoSCoW method Useful quantitative techniques: cost benefit analysis, QFD, Pareto analysis Dealing with requirements that are difficult to quantify 4 Organising the content The role of structure in specifications Typical contents and layout for a specification What goes where: introductory, key and supporting sections Creating and using model forms: the sections and sub sections Detailed contents of each sub-section Exercise: applying the tools and techniques 5 Writing the specification Identifying and understanding the specification reader Key words: will, shall, must; building and using a glossary Writing performance targets that are clear and unambiguous Choosing and using graphics Exercise: writing a specification 6 Editing and releasing the document Key editing issues for specifications Issue and control of specifications Module 3: Writing better reports 1 Introduction Aims and objectives of the day Introductions and interests of participants The 'POWER' technical writing process for technical reports 2 Creating better reports What is a technical report? types and formats of report The role and characteristics of an effective technical report Understanding technical report readers and their needs The commercial role and impact of technical reports Getting organised: the key stages in compiling a technical report 3 Preparing to write reports Agreeing the terms of reference; defining aims and objectives Being clear about constraints; defining what is not to be included Legal aspects and intellectual property rights (IPR) for reports Preparing the ground; gathering information and reference documents Keeping track of information: note making, cataloguing and cross referencing Tools and techniques for developing a valid and convincing argument 4 Organising the content The role of structure reviewed; some typical report structures Who needs what: identifying the varied needs of the readership What goes where: introductory, key and supporting sections Creating and using model forms: the sections and sub sections Detailed contents of each sub-section Exercise: applying the tools and techniques 5 Writing the report Planning the storyline: the report as a journey in understanding Recognising assumptions about the reader; what they do and don't know Converting complex concepts into understandable statements Presenting technical data and its analysis; the role of graphics Presenting the case simply whilst maintaining technical integrity Exercise: writing a technical report 6 Editing and releasing the report Key editing issues for technical reports Issue and control of technical reports

This intensive one-day training programme has been developed to help those involved in producing specifications create high quality documents in an organised and effective way. The programme explains the primary purpose of specifications and the importance of understanding the context in which they are used. It focuses particularly on how to develop and structure content and write requirements that are clear and concise. The methods and techniques presented will provide a practical foundation course for those new to the topic whilst offering new insights to those with more experience. The objectives of the workshop are to: Review and discuss the role and purpose of specifications Present a structured approach for organising and producing specifications Explain each of the key steps involved in creating effective specifications Review some methods for assisting in defining requirements Explain how to define the scope and develop the structure for a specification Present methods to assist the writing and editing of specifications Review how specifications should be issued and controlled 1 Introduction Course objectives Review of participants' needs and objectives 2 Specifications in perspective The role and purpose of specifications The impact of specifications on commercial performance The qualities of an effective specification The five key steps of 'POWER' writing: prepare-organise-write-edit-release 3 Step 1: Preparing to write Defining the purpose the specification; integrating the specification and contract Deciding how to specify: when to specify in functional and technical terms Getting the right people involved at the right time; engaging stakeholders Applying procedures for writing, issuing and controlling specifications 4 Step 2: Organising the specification content Scoping the document: scope maps, check lists, structured brainstorming Clarifying requirements; separating needs and desires Dealing with requirements that are difficult to quantify Useful techniques: cost benefit analysis, Pareto analysis Deciding what goes where; typical contents and layout for a specification Creating and using model forms: typical sections and sub sections 5 Step 3: Writing the specification Identifying and understanding the readers needs Choosing and using the right words; dealing with jargon Important words; will, shall, must; building 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 6 Step 4: Editing the specification Why editing is difficult; how to develop a personal editing strategy Key areas to review: structure, content, accuracy, clarity, style and grammar Editing tools and techniques 7 Step 5: Releasing and controlling the specification Key requirements for document issue and control Final formatting and publication issues; document approval Requirements management: managing revisions and changes 8 Course review and action planning What actions should be implemented to improve specifications? Conclusion