OpenCourser brand icon
Sign in
We may earn an affiliate commission when you visit our partners.
Course image
Udemy logo

The New Trainer's Guide to Creating End User Documentation

4.4 Filled star Filled star Filled star Filled star Empty star
Based on 1,377 ratings
see reviews
Michele Banks

This course is for anyone who is responsible for training or supporting end user software. Whether you are a new trainer, manager, support desk or a seasoned associate, this course will teach you techniques and skills to write end user documentation that gets used. You don’t need any prior technical writing or instructional design experience so you can jump right in and start using these techniques right now.

Read more

This course is for anyone who is responsible for training or supporting end user software. Whether you are a new trainer, manager, support desk or a seasoned associate, this course will teach you techniques and skills to write end user documentation that gets used. You don’t need any prior technical writing or instructional design experience so you can jump right in and start using these techniques right now.

You will learn how to write clear, accurate steps that always ensure the user knows exactly what to do. You will explore techniques that keep documentation concise and simple so users aren’t overwhelmed and disregard training materials. We won’t spend time on lengthy explanations of theory but we will focus on real world, practical writing that you can use Today. This course is filled with real world examples of instructional writing that you can use to practice your new skills. Every exercise comes with a review session to help you understand how and why the revision and writing is needed.

In addition, you will be provided with a wealth of downloadable resources. Included in this course is a style guide which will cover software conventions and terminology. Also included are style guides that outline documentation structure, instructional techniques, syntax and key grammar techniques. You will have additional resources for techniques to reduce information overload and writing in plain language. You will have all the information at your fingertips as you begin writing your documents.

Enroll now

What's inside

Syllabus

Technical Writing Concepts

Information regarding what to expect from the course, who will benefit from the course and what the course covers.

Read more

This lecture helps you understand your end users point of view

This lecture covers the three main concepts you should employ when beginning an end user documentation project.

You will understand the importance of writing documentation based on the user's skill level.

This lecture defines data dumping and mental clutter and how to recognize each.

This lectures covers strategies to avoid adding mental clutter to documentation.

This lecture covers common examples of mental clutter to avoid.

This lectures covers the reasons why you should use and follow a writing style guide.

This lecture covers naming, structure and formatting for common UI command elements such as buttons.

This lecture covers naming, structure and formatting for menus, drop downs and lists.

This lecture covers naming, structure and formatting for windows, hyperlinks and check boxes.

This lecture covers naming, structure and formatting for keyboard presses and phone gestures.

This lectures covers recommended formatting and the  most common formatting mistakes.

This lectures cover writing a compound user action statement and the importance of standard terminology.

This lectures covers strategies for identifying and writing jargon acronyms.

This lectures covers strategies for accurately naming icons.

Covers the use a common structural design when creating documents.

Review of strategies to keep titles short, concise and easy for users to understand.

You will learn the components to include in a documents opening paragraph.

Covers strategies to break up long instructions into useful groupings that users can easily scan.

Review methods of adding subheadings and associated overviews.

Tips for accurately documenting steps.

How to determine what is a step and what is not a step.

How to identify and correctly write substeps.

Tips to identify when a steps is conditional and how to correctly write a conditional step.

How to document and identify the difference between alternative and optional steps

How to format data input known to the end user.

How to write steps for data input known to the end user.

This lecture covers strategies to avoid re-writing steps.

This lecture defines the 5 basic types of information.

Strategies and techniques for writing information about a step.

Strategies and techniques for addressing prerequisites, warnings and cautions.

Strategies and techniques for addressing errors, confirmations and system messages.

Strategies and techniques for addressing results of user actions.

Strategies and techniques for addressing hints, tips and shortcuts.

Traffic lights

Read about what's good
what should give you pause
and possible dealbreakers
Provides downloadable resources, including style guides covering software conventions, terminology, documentation structure, instructional techniques, syntax, and key grammar techniques, which are essential for creating professional documentation
Focuses on real-world, practical writing with examples and exercises, making it immediately applicable to creating effective end-user documentation, which is useful for on-the-job training
Explores techniques to keep documentation concise and simple, which helps to avoid overwhelming users and ensures that training materials are actually used and understood
Teaches how to write clear, accurate steps that ensure the user knows exactly what to do, which is a foundational skill for anyone creating end-user documentation
Covers strategies for identifying and writing jargon acronyms, which is important for ensuring clarity and avoiding confusion in technical documentation
Includes exercises with review sessions to help understand how and why revisions and writing are needed, which reinforces learning and promotes skill development

Save this course

Create your own learning path. Save this course to your list so you can find it easily later.
Save

Reviews summary

Practical guide to end user documentation

According to learners, this course serves as a highly practical guide for creating end user documentation. Many students found the techniques and strategies taught were immediately applicable to their work, making it particularly valuable for those new to training or documentation roles. The course is praised for its clear explanations and well-structured content, breaking down the process into manageable steps. Reviewers frequently highlight the downloadable resources, such as style guides, as being particularly useful. While generally well-received, some experienced technical writers noted that the material is introductory and might not offer significant new insights for seasoned professionals.
Ideal for those new to documentation.
"As a new trainer, this course was exactly what I needed to get started."
"Perfect for someone who has never done technical writing before."
"This course is great for beginners or people who want a refresh on core concepts."
"If you're an experienced tech writer, this might be too basic for you."
Practice opportunities reinforce learning.
"The exercises provided were very helpful for practicing the techniques."
"Reviewing the exercises helped solidify my understanding of the concepts."
"While some were basic, the exercises reinforced key learning points effectively."
Useful templates and guides provided.
"The downloadable style guide is worth the price of the course alone."
"Having the templates and resource sheets at my fingertips is a huge bonus."
"These resources are fantastic references to keep using long after the course is finished."
"Appreciated the extra resources for writing in plain language and reducing information overload."
Concepts are explained simply and directly.
"The instructor explains everything in a very clear and concise manner."
"Complex ideas about formatting and structure were made easy to understand."
"Lectures are well-organized and easy to follow, making learning effortless."
"The way concepts like mental clutter and conditional steps are explained is very straightforward."
Skills can be used immediately on the job.
"The practical tips and techniques for writing clear documentation steps are game-changers. I'm already applying them at work."
"Learned concrete strategies that I could use right away to improve my team's training materials."
"Focus on real-world examples and practical writing makes this course incredibly valuable."
"I appreciate that the course didn't dwell on theory but gave actionable steps."
"Finally feel like I have a handle on how to write docs that users will actually understand and use."
Experienced users may find it introductory.
"For someone with years of technical writing experience, this course felt quite basic and repetitive in parts."
"I was hoping for more advanced techniques, but this seems geared towards beginners."
"Didn't cover many new concepts if you already have some background in instructional design."

Activities

Be better prepared before your course. Deepen your understanding during and after it. Supplement your coursework and achieve mastery of the topics covered in The New Trainer's Guide to Creating End User Documentation with these activities:
Review Technical Writing Concepts
Reinforce your understanding of fundamental technical writing principles before diving into the course.
Browse courses on Technical Writing
Show steps
  • Review online articles and blog posts on technical writing best practices.
  • Practice writing clear and concise instructions for a simple task.
Read 'The Elements of Style'
Improve your writing skills by studying a classic guide to style and grammar.
View Melania on Amazon
Show steps
  • Read the book cover to cover, paying attention to the rules of grammar and style.
  • Practice applying the principles in your own writing.
Document a Simple Software Feature
Apply the course concepts by documenting a real-world software feature.
Show steps
  • Choose a software application and a specific feature to document.
  • Identify the target audience and their skill level.
  • Write clear, concise, and accurate steps for using the feature.
  • Include screenshots and other visual aids to enhance understanding.
  • Get feedback from others and revise your documentation accordingly.
Four other activities
Expand to see all activities and additional details
Show all seven activities
Create a Style Guide Cheat Sheet
Reinforce your understanding of style guide principles by creating a concise cheat sheet.
Show steps
  • Review the course's style guide and other relevant resources.
  • Identify the most important rules and conventions.
  • Create a one-page cheat sheet summarizing these rules.
  • Share your cheat sheet with other students for feedback.
Rewrite Ambiguous Instructions
Sharpen your ability to write clear and unambiguous instructions through targeted practice.
Show steps
  • Find examples of poorly written instructions online or in existing documentation.
  • Identify the specific areas where the instructions are unclear or ambiguous.
  • Rewrite the instructions to be more precise and easy to understand.
  • Compare your revised instructions with the original and explain the improvements you made.
Read 'Technical Writing For Dummies'
Expand your knowledge of technical writing with a comprehensive guide for beginners.
View Business Writing with AI For Dummies on Amazon
Show steps
  • Read the book cover to cover, focusing on the areas that are most relevant to your work.
  • Take notes on the key concepts and techniques.
Answer Questions in Online Forums
Solidify your understanding by helping others learn the material.
Show steps
  • Find online forums or communities related to technical writing or end-user documentation.
  • Search for questions that you can answer based on your knowledge from the course.
  • Provide clear, concise, and helpful answers to the questions.
  • Be respectful and patient with those who are learning.

Career center

Learners who complete The New Trainer's Guide to Creating End User Documentation will develop knowledge and skills that may be useful to these careers:
Documentation Specialist
A documentation specialist focuses on creating and managing documentation for software, hardware, or other products. This course provides a good foundation for success. The course's emphasis on writing clear, accurate documentation for end users is essential for a documentation specialist. You will learn how to write concise steps, use a style guide, and avoid overwhelming users with unnecessary information. The course focuses on practical writing techniques and the inclusion of downloadable resources on style guides and writing techniques makes this course perfect for the documentation specialist.
See salaries and explore the career path for Documentation Specialist
Technical Writer
A technical writer creates documentation to help people understand and use complex products or services. This course helps build a foundation for this role. The course focuses on writing clear, accurate documentation for end users, a key skill for any technical writer. You'll learn how to write concise steps, use a style guide, and avoid overwhelming users with unnecessary information. The emphasis on real-world examples and practical writing, not theoretical explanations, will be especially valuable. The coverage of UI elements, terminology, formatting, and common writing mistakes may also be useful for someone who wants to become a technical writer.
See salaries and explore the career path for Technical Writer
Software Trainer
A software trainer teaches individuals how to use specific software applications. This course will help someone become a software trainer. The course is specifically designed for those responsible for training or supporting end-user software. The course teaches techniques to write end-user documentation that is clear, accurate, and concise. The downloadable resources, including style guides and information on instructional techniques, will also be helpful for anyone who wants to become a software trainer because this course teaches this skill.
See salaries and explore the career path for Software Trainer
Training Specialist
A training specialist develops and delivers training programs for employees or customers. This course provides skills directly applicable to this role. Training materials often include end-user documentation, and this course teaches you how to create documentation that is clear, concise, and effective. The course's focus on writing accurate steps, using a style guide, and reducing information overload helps a training specialist. The exploration of instructional techniques, terminology, syntax, and grammar also may be useful for someone who wants to become a trainer. The emphasis on practical writing and real-world examples makes this course for the training specialist.
See salaries and explore the career path for Training Specialist
Training Coordinator
Training coordinators organize and administer training programs, including the creation and distribution of training materials. This course can help training coordinators become more effective in their roles. Training materials often include end-user documentation, and this course equips one with the knowledge to ensure this documentation is clear, concise, and user-friendly. The course's focus on writing accurate steps, using a style guide, and reducing information overload helps a training coordinator. The material on terminology, syntax, and grammar may also be useful to someone who wants to become a training coordinator.
See salaries and explore the career path for Training Coordinator
Knowledge Base Manager
A knowledge base manager is responsible for creating and maintaining a repository of information for users and support staff. A key task is creating and organizing documentation, so this course is invaluable. The course's focus on writing clear, accurate steps, creating effective structures, and avoiding information overload helps a knowledge base manager. The downloadable style guides and resources may also be helpful for the knowledge base manager. The course's emphasis on practical writing and real-world examples provides the knowledge base manager with the tools to create a useful documentation base.
See salaries and explore the career path for Knowledge Base Manager
Curriculum Developer
Curriculum developers design and create educational curricula, including documentation and instructional materials. This course can lead to success in this role. Part of the course is how to create clear and concise instructions tailored to the user's skill level; this makes the course useful for those interested in this role. The course helps to write accurate steps and avoid overwhelming users with unnecessary information. You will explore instructional techniques. You will also have resources on style guides. Anyone considering a career as a curriculum developer will find this course helpful.
See salaries and explore the career path for Curriculum Developer
Instructional Designer
Instructional designers create learning materials and experiences. While this role involves broader learning design skills, this course can lead to success in this career. A major part of instructional design involves creating documentation for software or systems, something this course addresses in detail. You will learn how to write clear and concise instructions tailored to the user's skill level. The focus on practical writing techniques, along with downloadable resources on style guides and instructional methods, may also be helpful when writing documentation. The emphasis on avoiding mental clutter and writing in plain language may be useful in the instructional designer role.
See salaries and explore the career path for Instructional Designer
Help Desk Specialist
Help desk specialists provide technical support to users, often involving writing documentation and guides. This course can lead to success in this role. A help desk specialist often needs to create clear, concise instructions to help users resolve issues, and this course teaches how to write accurate steps and avoid overwhelming users with unnecessary information. The course's focus on understanding the user's point of view and writing at the appropriate skill level may also be helpful for someone who wants to work at the help desk. The resources on software conventions and terminology may be useful for the help desk specialist.
See salaries and explore the career path for Help Desk Specialist
Technical Editor
Technical editors review and edit technical documents for clarity, accuracy, and consistency. This course may be useful for individuals who want to become a technical editor. The course's focus on writing clear and concise documentation and understanding end-user needs may be helpful for a technical editor. The course may also help the technical editor to improve end-user documentation and ensure that it aligns with the needs of the target audience. The emphasis on practical writing techniques also may be useful.
See salaries and explore the career path for Technical Editor
Content Writer
Content writers create engaging and informative content for various platforms. This course may be useful for content writers. This is because clear and concise communication is essential. The course teaches techniques for writing understandable instructions and simplifying complex information. By focusing on end-user documentation, it helps content writers adopt a user-centric approach to their writing. The downloadable style guides and resources also may be helpful. Anyone considering a career as a content writer who values clarity and accessibility should take this course.
See salaries and explore the career path for Content Writer
eLearning Developer
eLearning developers create online training courses and interactive learning modules, which often include end-user documentation. This course may be useful for the eLearning developer. The course's focus on writing clear and concise documentation and providing clear instructions tailored to the user's skill level may be helpful. The course will familiarize the user with how to write accurate steps and avoid overwhelming users with unnecessary information. The course focuses on practical writing techniques. This may make the eLearning developer more effective.
See salaries and explore the career path for eLearning Developer
Technical Support Engineer
Technical support engineers often create documentation and guides to help users troubleshoot and resolve technical issues. This course may be helpful for this position. The course helps in creating clear, concise instructions; this is an important skill for a technical support engineer. The training in writing accurate steps and avoiding overwhelming users may be useful. The resources on software conventions and terminology may also be helpful for the technical support engineer.
See salaries and explore the career path for Technical Support Engineer
Business Analyst
Business analysts document business processes and system requirements, often involving end-user documentation. This course may be useful for a business analyst. The course's focus on writing clear and concise documentation for end users helps a business analyst communicate complex information effectively. You will learn to write accurate steps and avoid overwhelming users with unnecessary detail. The techniques for writing concise steps, the style guide, and focus on real-world examples will be especially valuable for the business analyst.
See salaries and explore the career path for Business Analyst
Usability Tester
Usability testers evaluate the ease of use of software and hardware. A key skill is the ability to document problems and provide clear feedback, so this course is helpful. The course helps to evaluate the clarity and effectiveness of end-user documentation. The focus on writing clear, accurate steps and avoiding information overload may be useful for a usability tester. The training on understanding the user's perspective and writing at the appropriate skill level is beneficial to the usability tester.
See salaries and explore the career path for Usability Tester

Reading list

We've selected two books that we think will supplement your learning. Use these to develop background knowledge, enrich your coursework, and gain a deeper understanding of the topics covered in The New Trainer's Guide to Creating End User Documentation.
Cover image
Business Writing with AI For Dummies
Save
Provides a broad overview of technical writing principles and techniques. It covers a wide range of topics, including planning, writing, and editing technical documents. It is particularly useful for beginners who are new to technical writing. This book is best used as additional reading to provide more breadth to the existing course.
Business Writing with AI For Dummies
Paperback
$$

Share

Help others find this course page by sharing it with your friends and followers:
Facebook
LinkedIn
Reddit
X
Link
Email

Similar courses

Similar courses are unavailable at this time. Please try again later.
Course image
Rating
4.4 Filled star Filled star Filled star Filled star Empty star
Effort
3 total hours
Via
Udemy
Instructor
Michele Banks
Language
English
Traffic lights
Read about what's good
what should give you pause
and possible dealbreakers
Provides downloadable resources, including style guides covering software conventions, terminology, documentation structure, instructional techniques, syntax, and key grammar techniques, which are essential for creating professional documentation
Focuses on real-world, practical writing with examples and exercises, making it immediately applicable to creating effective end-user documentation, which is useful for on-the-job training
Explores techniques to keep documentation concise and simple, which helps to avoid overwhelming users and ensures that training materials are actually used and understood
Teaches how to write clear, accurate steps that ensure the user knows exactly what to do, which is a foundational skill for anyone creating end-user documentation
Covers strategies for identifying and writing jargon acronyms, which is important for ensuring clarity and avoiding confusion in technical documentation
Includes exercises with review sessions to help understand how and why revisions and writing are needed, which reinforces learning and promotes skill development
Share this
Share to help others discover this course.
Facebook LinkedIn X Reddit Link Email
Begin learning today
Enroll now to gain full access to The New Trainer's Guide to Creating End User Documentation.
Enroll now
Save for later
Add this course to your list. Find it anytime.
Save
Our mission

OpenCourser helps millions of learners each year. People visit us to learn workspace skills, ace their exams, and nurture their curiosity.

Our extensive catalog contains over 50,000 courses and twice as many books. Browse by search, by topic, or even by career interests. We'll match you to the right resources quickly.

Find this site helpful? Tell a friend about us.

Affiliate disclosure

We're supported by our community of learners. When you purchase or subscribe to courses and programs or purchase books, we may earn a commission from our partners.

Your purchases help us maintain our catalog and keep our servers humming without ads.

Thank you for supporting OpenCourser.

© 2016 - 2025 OpenCourser