levo

Implementation and System Security

User documentation

  • 3 things to know
  • AS Unit 1

Overview

User documentation, five sections found in a typical user guide and context-sensitive help.

What you need to know

Answer each one before you reveal it.

Your recallNot started
Key term

Name five sections found in a typical user guide.

Key term

What is user documentation?

Key term

Why does user documentation avoid technical language?

Questions from this subtopic

Each one with the model answer underneath.

  1. 1

    What is user documentation?

    Model answer

    User documentation is the material written to help the people who operate a system carry out their tasks with it correctly.

  2. 2

    Name five sections found in a typical user guide.

    Model answer

    A user guide typically contains installation instructions, an explanation of how to start the system, step-by-step instructions for each task, a list of error messages and their meanings, and a troubleshooting section.

  3. 3

    Why does user documentation avoid technical language?

    Model answer

    User documentation is read by people who operate the system rather than build it, so terms they would not recognise make the instructions useless to them.

  4. 4

    What is a troubleshooting section for?

    Model answer

    A troubleshooting section lists the common problems users meet, with the likely cause and the action to take, so ordinary difficulties are solved without contacting the support desk.

  5. 5

    Why are screenshots included in user documentation?

    Model answer

    A picture of the screen lets the reader confirm they are in the right place and see exactly which control an instruction is referring to.

  6. 6

    Give two forms in which user documentation can be supplied.

    Model answer

    User documentation can be supplied as a printed manual and as searchable help built into the software itself.

Other ways to work this

The same content, four other ways.

What is inside Levo

Six ways to work the same material.

1Closed book
2Open book
3Closed book

The 3-step method, run for you

Answer cold, learn it, then prove it stuck. Levo tracks the jump between your first attempt and your last.

Systems Analysis and Development Approaches
Design, Development and Testing
Implementation and System Security
Programming

Cram a whole paper in one sitting

Sort every topic into what you know and what you do not, then drill only the weak ones.

A check requires a value.
presencerangeformat

Blank Blitz makes facts automatic

Rapid timed gap-fills on the terms and numbers you need to recall without thinking.

ANormal data is 12, which should be accepted.
BBoundary data is 1 and 50, which should be accepted.
C0 and 51, just outside the limits, should be rejected.

Build It gets the exam shape right

Assemble a full-mark answer from its marking points, in the order an examiner wants them.

One byte is made up of 8 bits.
TrueFalse

Test It catches misconceptions

Spot the fault in a statement. The traps are the mistakes students actually make.

721941163128510

Brain Breaks between sessions

Short focus games to reset attention, so the next set lands better than the last.

Every question in Implementation and System Security, on a schedule.

Attempt a question from memory, write the correct version, then attempt it again. Levo records the jump between your first attempt and your last, and brings each question back on the day you are due to forget it.

Or £46 a year, about £3.83 a month. Cancel anytime.