levo

The Development Project: Build, Testing and Evaluation

The electronic user guide

  • 3 things to know
  • A2 Unit 2

Overview

Electronic user guide, context-sensitive help and difference between a user guide and technical documentation.

What you need to know

Answer each one before you reveal it.

Your recallNot started
Key term

Why is the guide made accessible from the user interface?

Key term

What should a user guide contain?

Key term

What is the difference between a user guide and technical documentation?

Questions from this subtopic

Each one with the model answer underneath.

  1. 1

    What is an electronic user guide?

    Model answer

    An electronic user guide is documentation built into the solution and reachable from its interface, which explains to the end user how to carry out each task the system supports.

  2. 2

    Why is the guide made accessible from the user interface?

    Model answer

    Help is needed at the moment of difficulty, and a user who has to find a separate document will guess instead. A guide reachable from the screen is used; one in a drawer is not.

  3. 3

    What is context-sensitive help?

    Model answer

    Context-sensitive help opens at the page relevant to whatever the user is doing, so pressing help on the booking form shows the section about bookings rather than the contents page.

  4. 4

    What should a user guide contain?

    Model answer

    A user guide contains an introduction to what the system is for, instructions for each task in the order the user performs it, an explanation of every message the system can show, a description of the validation rules, and guidance on what to do when something goes wrong.

  5. 5

    Who is a user guide written for, and how does that shape it?

    Model answer

    A user guide is written for the person operating the system, not for a developer, so it is organised by the tasks they do rather than by the modules the system contains, and it uses their vocabulary rather than technical terms.

  6. 6

    What is the difference between a user guide and technical documentation?

    Model answer

    A user guide tells an operator how to use the system. Technical documentation tells a developer how the system is built — the data structure, the algorithms, the code — so that it can be maintained.

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 The Development Project: Build, Testing and Evaluation, 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.