Electrical engineering courses

PRACTICAL SPECIFICATION & TECHNICAL WRITING

Ref No: 2015065

Chapter1: Introduction 
1.0 Introduction 
1.1 What is technical writing? What makes it unique? 
1.2 Objectives of technical writing (ABC's of writing) 

  • 1.2.1 Accuracy 
  • 1.2.2 Brevity 
  • 1.2.3 Clarity 

1.3 Categories of readers 

  • 1.3.1 Skilled/expert/specialist 
  • 1.3.2 Decision-maker 
  • 1.3.3 Technician/operator 
  • 1.3.4 General reader or non specialist 

1.4 Effective communication 
1.5 Expressing versus impressing 

Chapter 2: Development Process 
2.1 Preparing to write 

  • 2.1.1 Establish the writing objective 
  • 2.1.2 Identify your readers 
  • 2.1.3 Perform research 

2.2 Organizing the writing 

  • 2.2.1 The writing process 
  • 2.2.2 Methods of development 
  • 2.2.3 Document outlining 
  • 2.2.4 Idea generators 
  • 2.2.5 Writing the rough draft 
  • 2.2.6 Editing and revision 
  • 2.2.7 Proofreading 

Chapter 3: Language and Word 
3.0 Readability 
3.1 Clarifying the writing 
3.2 Choice of vocabulary 
3.3 Simplifying the writing 

Chapter 4: The elements of Technical Writing 
4.0 The elements of technical writing
4.1 Technical definitions 

  • 4.1.1 Informal definition 
  • 4.1.2 Formal definition 
  • 4.1.3 Extended definition 

4.2 Technical descriptions 

  • 4.2.1 Description of a mechanism 
  • 4.2.2 Process for writing a description of a mechanism 
  • 4.2.3 Description of a process 

4.3 Technical instructions 

  • 4.3.1 A technical instruction is made up of three elements 
  • 4.3.2 Technical instruction checklist 
  • 4.3.3 Outline for instruction sheet 

Chapter 5: Formats of Technical Writing 
5.0 Types of technical reports 
5.1 Formal report 

  • 5.1.1 Introduction 
  • 5.1.2 Main body 
  • 5.1.3 Conclusion 
  • 5.1.4 Recommendations 
  • 5.1.5 Executive summary 

5.2 Other sections 

  • 5.2.1 Title of a report/title page 
  • 5.2.2 Table of contents 
  • 5.2.3 List of illustrations 
  • 5.2.4 References/bibliography 
  • 5.2.5 Appendices 
  • 5.2.6 Glossary 
  • 5.2.7 Other sections 

5.3 Technical memo report 

  • 5.3.1 Types of reports 
  • 5.3.2 Technical background (lab) report 

5.4 Other technical documentation 

  • 5.4.1 Technical proposal 
  • 5.4.2 Technical manuals (user and maintenance) 
  • 5.4.3 Journal article

Trainees shall receive a portfolio containing a comprehensive course manual.

Attendees shall receive a certificate of attendance from AMAD Tech.