Course Content – Technical Writing Basics

Course Content – Technical Writing Basics

Technical Writing Basics


Schedule Date Time PDH Venue/Platform Cost Register
Spring 2024 April 22, 2024 8:00 AM – 5:00 PM
Central Time (UTC -6)
8 hrs.
(1 day)
Sheraton North Houston at George Bush Intercontinental
Accepts in-person and virtual attendees
US$1,200

Description:

This course provides basic guidance and Best Practices to be followed when creating technical documentation. The background and purpose of technical writing standards will be discussed, as well as the standards themselves. Examples and exercises will be provided and workshopped throughout the course to provide trainees with hands-on experience and practical applications of the standards. Formatting best practices for Microsoft Word and PowerPoint documentation will be discussed, along with useful tips and tricks to streamline the documentation process.

Outline:
Introduction
  • Course Objectives
  • Purpose of Technical Writing Standards
Documentation Process
  • Understanding Scope
  • Information Sources
  • Stakeholder Input
  • 3-Cs (Coherent, Concise, Consistent)
  • Standardizing Language and Terminology
  • Undocumented equipment
  • Specifying new equipment
  • Templating
  • Enforcement and Alignment of Standards
Writing Style and Mechanics
  • 6 Traits of Writing
  • ⁃ Ideas
    ◦ Scope
    ⁃ Organization
    ◦ Sequencing, Scaffolding, Parallelism
    ⁃ Voice
    ◦ Active Voice, Accurate Language
    ⁃ Word Choice
    ◦ Accurate Wording, Standard Terminology
    ⁃ Sentence Fluency
    ⁃ Mechanics/Conventions
    ◦ Grammar, Punctuation
Document Formatting
  • Word Documents
  • ⁃ Table of Contents
    ⁃ Headings
    ⁃ Spacing and Alignment
    ⁃ Correct Use of Templates
    ⁃ Emphasis
    ⁃ Figures, charts, tables and captions
    ⁃ Footnotes
    ⁃ Documents Header and Footer
  • PowerPoint Slides (optional)
  • ⁃ Consistency in Headings
    ⁃ Consistency in font sizes
    ⁃ Use of images
    ⁃ Tables
    ⁃ SmartArt
    ⁃ Layout and templating
    ⁃ Master View and Handout View
Tips & Tricks
  • Shortcuts
  • Helpful tips
  • Q&A
Who Should Attend:
This course is suitable for anyone who works with documentation and reporting in the oil & gas industry, including non-technical personnel, operations and maintenance personnel, and engineers.
Instructor:
Maureen Brody
Maureen Brody has over 10 years of experience in professional and technical writing, analysis, and project management. Her extensive research and writing experience spans a variety of fields, including market research, training program development, and the creation of knowledge transfer materials. As a former teacher, she brings superior skills in curriculum development, project management, program development, customer engagement, and communications, as well as a healthy dose of patience! Her creativity, as well as attention to detail, are major assets in the development of training materials, technical documents, and assessments. Maureen’s experience includes pharmaceuticals and consumer packaged goods, oil & gas, education, and non-profits. Maureen holds a BA in English from Pennsylvania State University.

Download Course Content
PDF

Discounts:
Becht offers the following discounts on Public Training:

The highest applicable discount will be applied; discounts are not additive.

  1. Early Registration – A 10% discount is to be provided when you register 30 days before the start date of the training.
  2. Group Rate – A group discount is applied when you send three or more people from your organization to the same course and provide a single payment.
  3. No. of Registrants Discount/Person
    3 10%
    4 – 6 20%
    7 and up 25%
  4. Yearly Commitment Discount – A 25% discount when you prepay for a minimum of 10 participants from your organization to any of the courses in the same year.

Virtual Training Platform:
GoToTraining is Becht’s interactive online training solution with the most reliable features to help you before, during, and after your sessions. GoToTraining is a robust training platform that engages participants/attendees virtually.

Cancellation Policy:
A full refund is available for cancellations more than 30 days before course start date. Within 30 days of course start date, course credit can be transferred to another attendee within the same company, or can be kept on file to be applied to a future Becht training course.

For information regarding the training course, contact the Training Coordinator at Training@becht.com.

Let Becht Turn Your Problem
Into Peace of Mind