LE3 - User Documentation

1 / 28
next
Slide 1: Slide
ICTMBOStudiejaar 1

This lesson contains 28 slides, with interactive quizzes, text slides and 2 videos.

Items in this lesson

Slide 1 - Slide

Slide 2 - Slide

Slide 3 - Slide

LE7 - User documentation
This term English combined with IT.
  1. A written user instruction in English (individual)
  2. An English video instruction (Teams) (in pairs)
  3. Helpdesk telephone call (Teams) (in pairs)

    (so if you are exempt it might be wise to follow class)

Slide 4 - Slide

LE3 - User documentation
Goals?
  • I will learn how to write a clear instruction manual
  • I will know what a clear instruction manual is
  • I will learn to make a clear video instruction

Slide 5 - Slide

Have you ever read a manual?
Yes
No
WTF?

Slide 6 - Poll

timer
1:00
What is user documentation?

Slide 7 - Mind map

Slide 8 - Slide

What does a good user documentation need?
timer
1:00

Slide 9 - Open question

Slide 10 - Slide

Common mistakes
Grammar issues
Native language influence
Bad structure
Lack of details
Lack of pictures


Slide 11 - Slide

Benefits of User Documentation
  • Customer satisfaction
  • Support team productivity
  • Customer experience

Slide 12 - Slide

Slide 13 - Video

Slide 14 - Slide

Look at the instruction, is it clear, why / why not?

Slide 15 - Open question

timer
1:00
Identify the Audience
Define the Purpose of the Manual
Graphics
Be brief and clear
Identify the How-To Steps
Test it.
1
2
3
4
5
6

Slide 16 - Drag question

First steps
Step 1: Identify the Audience
Step 2: Define the Purpose of the Manual
Step 3: Identify the How-To Steps
Make them clear and step by step
Step 4. Graphics
Step 5: Be brief and clear
Step 6: Test it.

Slide 17 - Slide

  •     Choose an appropriate font. (Arial or Calibri.)
  •     Don’t use a font smaller than 10-point type.
  • Depending on your audience, you may need to use a larger font.
  •     Use headings to highlight transitions from one section to another.
  • Include subheadings within heading sections as needed.
  •     Present steps that must be followed in order in a numbered list format.
  •     Use bulleted lists and/or tables to highlight key information.

Slide 18 - Slide

Without pictures make an instruction how I have to make a cuppa tea. (in steps)

Slide 19 - Open question

Part 2
Video Instruction:

Slide 20 - Slide

Slide 21 - Slide

Slide 22 - Video

What?
An instructional video is any video that demonstrates a process, transfers knowledge, explains a concept, or shows someone how to do something.

(So, basically your written instruction translated to video :) )

Slide 23 - Slide

Micro videos
Micro videos are short instructional videos that focus on teaching a single, narrow topic. They’re usually less than a minute long and appeal to today’s media consumers, who have notoriously short attention spans.
Tutorial videos
Tutorial videos are the go-to instructional method for teaching a process or providing step-by-step instructions. Usually between 2-10 minutes long, tutorial videos may leverage multiple instructional methods.

Sometimes referred to as “how-to” videos, the best ones are carefully planned and have a professional touch.

Slide 24 - Slide

How
  • Use a script
  • Be clear and precise (vocal and visually)
  • Don't use fancy FX
    (Or funky music)
  • Know who you are talking to
  • Make it flow.
  • Test it
  • Make the customer happy!

Slide 25 - Slide

Tools?
  • Windows Steps Recorder
  • Teams
  • Discord
  • OBS Studio :)
  • Free tools

Slide 26 - Slide

Have we met our goals?
😒🙁😐🙂😃

Slide 27 - Poll

Tasks
NU Engels Homework (Planning)
Reading Test
Or start on your User Instruction.

Slide 28 - Slide