IB-Learning: practical, hands-on training for software developers, software testers, business analysts and project managers

Spotlight On

• Curriculums
  • Business Analysis
  • Business Skills
  • Mainframe
  • Relational Database Management Systems
  • Software Testing
  • Windows Desktop
  • WebSphere MQ
  • Project Management
  • IT Service Management
  
  
• Class Schedules
• Facility Rentals
• Special Offers!

Technical Writing and Documentation - SS28 ( 2 Days )

Course Outline

Abstract/Overview

This two-day workshop will provide new tools and skills to help participants plan, write, edit, and preserve technical documentation of all kinds. Up-to-date practices for grammar and usage will be reviewed, and participants will learn new techniques for developing the active, clear style suited to technical documents. The workshop features hands-on writing exercises and activities that allow new concepts to be applied in realistic situations.

Audience - Who Should Attend?

Prerequisite

None

Objective

Content

Overview of Technical Writing

• The characteristics of effective technical writing
• Working with SMEs to get reliable source data
• File naming and document numbering
• Developing and using comprehensive templates
• Strategies for version control

• Preparation and planning phase
• Drafting and writing phase -Delivery phase
• Archiving phase

• Features of a clear, understandable style
• Strategies for setting the correct tone
• Using examples, illustrations, diagrams, flowcharts and graphs
• Headings, bulleted lists and warning messages
• Document layout and design

• Professional techniques for spotting and correcting errors, glitches and inconsistencies
• Editing wordy, confusing prose to make messages clear and direct
• Restructuring to focus attention on key points and meanings
• Checklist for delivery and distribution

• Every participant receives a private writing assessment with customized tips and suggestions from the instructor
• Standing invitation to contact the instructor after the course for extra assistance and advice about writing projects