Technical writing is unique because of its specialized content. It conveys technical content through specific, clear and concise writing.
This course on technical writing helps the learner to assess the needs of the users and create documents that explain technical information. It also helps to learn the mechanics of good technical writing.
In addition to the above, the students also learn how to build effective sentences and sections that explain information clearly and create informative content that readers will understand and use.
WHO SHOULD COMPLETE THIS COURSE
- Engineers
- Scientists
- IT/Computer personnel and people in R&D
- Product owners
- Project /Functional Managers
- Product analysts
- Organizations and Corporations
- Anyone who wishes to enhance existing Technical writing skills.
COURSE OUTLINE
INTRODUCTION TO TECHNICAL WRITING
- Technical writing- Definition, meaning and where used.
- Attributes of Technical writing
- Categories of Readers
- Expression versus Impression
THE DEVELOPMENT PROCESS
- Preparing to write a document
- Establish objective
- Identify Readers
- Perform Research
ORGANIZING THE WRITING
- Methods of development
- Outline of Technical documents
- Outlining formats
- Revising the document -Editing, Revision, Proof- reading
USE OF LANGUAGE AND WORDS
- Grammar
- Punctuation and Parts of speech
- TWR and Author’s point of view `
CLARIFICATION OF WRITING PROCESS
- Types of sentences (Simple ,Complex and Compound)
- Voice - Active Vs Passive
SOME ADDITIONAL GRAMMAR ISSUES
- Subject-Verb agreement,
- Use of British and American English
- Punctuation
- Vocabulary
- Jargon and Cliches
- Fog Index
ELEMENTS OF TECHNICAL WRITING
- Basic elements of Technical writing-Description and examples
- Organizing process description/Instruction set
- Final check
FORMATS OF TECHNICAL WRITING
- Purpose of reports
- Structure of formal report
- Terms of Reference
- What a report should contain
INTRODUCTION TO REPORT WRITING
- Main body of the report
- What to include
- Conclusion and recommendations
- Executive Summary
- Other sections
- Technical report writing Vs Report writing
MEMO REPORTS AND OTHER TECHNICAL DOCUMENTS
- Memo Reports-Types and Functions
- Basic Structure
- Other technical documents
- Technical Manual-Purpose and categories of readers
- Technical proposal-Definition and Structure
- Journal article
WRITING OF SPECIFICATION
- Purpose of Specifications
- Phases of Specification
- Equipment Specification
- Client/Purchaser Specification
CONTENTS OF SPECIFICATION
- Scope
- Standards, codes and regulations
- Definition and Terminology
CONTENTS OF SPECIFICATION - II
- Materials of Construction
- Design Basis
- Mechanical/Fabrication
- Guarantees
- Testing and Inspection
- Documentation
- Shipping
PRESENTATION ASPECTS
- Preference of Desk top publishing to other methods
- Appearance of presentation-Book binders
- Document Designing
- Use of graphs, Tables and Illustrations
ORAL PRESENTATION OF TECHNICAL DOCUMENTS
- Personal factors
- Structure of presentation-Details
- Use of various tools for oral presentation
- Importance of timing
- Conclusion