Brainscape's Knowledge GenomeTM

Browse over 1 million classes created by top students, professors, publishers, and experts.


See full index

Creating User Documentation > All > Flashcards

All Flashcards

1
Q

Why may a user require User Documentation?

A

In order to learn new software applications

How well did you know this?
1
Not at all
2
3
4
5
Perfectly
2
Q

True/False…

An application is less likely to gain mainstream use with poorly written User Documentation

A

True

No matter how fully featured or compatible, with poorly written User Documentation, an application will be less likely to gain mainstream use.

How well did you know this?
1
Not at all
2
3
4
5
Perfectly
3
Q

What is one of the most important things to consider when writing User Documentation?

A

The target audience to ensure that the User Documentation is written at an appropriate language and technical level.

How well did you know this?
1
Not at all
2
3
4
5
Perfectly
4
Q

What are the four audiences of User Documentation?

A

Novice - No prior exposure

Intermediate - Basic training and exposure

Expert/Advanced - Highly Capable

Transfer - Expert level (out of date or different application)

How well did you know this?
1
Not at all
2
3
4
5
Perfectly
5
Q

Outline a novice user.

A

No prior exposure to an application.

How well did you know this?
1
Not at all
2
3
4
5
Perfectly
6
Q

Outline an Intermediate user.

A

Someone who has basic training and exposure to an application

How well did you know this?
1
Not at all
2
3
4
5
Perfectly
7
Q

Outline an expert/advanced user.

A

Someone who is highly capable in using a software application

How well did you know this?
1
Not at all
2
3
4
5
Perfectly
8
Q

Outline a Transfer user.

A

A user who is at an intermediate or expert level however is using (or accustomed to) an out-of-date or different application.

How well did you know this?
1
Not at all
2
3
4
5
Perfectly
9
Q

What is the purpose of industry standards when creating user documentation?

A

Industry standards provide guidelines on how to construct documentation.

How well did you know this?
1
Not at all
2
3
4
5
Perfectly
10
Q

What are the tree types of standards?

A

Industry Standards

Organisational Standards

Project Standards

How well did you know this?
1
Not at all
2
3
4
5
Perfectly
11
Q

What are the requirements of User Documentation for a novice user?

A

A novice user will require information about the software as well as an explanation on the basic terms and knowledge related.

How well did you know this?
1
Not at all
2
3
4
5
Perfectly
12
Q

What are the requirements of User Documentation for an Intermediate user?

A

An intermediate user requires documentation that illustrates how to use the application more efficiently or may introduce some of the more advanced features.

How well did you know this?
1
Not at all
2
3
4
5
Perfectly
13
Q

What are the requirements of User Documentation for an expert user?

A

An expert users’s need for a detailed user manual is limited; they may only require short guides or prompts on how to complete certain tasks.

How well did you know this?
1
Not at all
2
3
4
5
Perfectly
14
Q

What are the requirements of User Documentation for a transfer user?

A

Transfer users require information about the new application and how it differs form the previous software.

How well did you know this?
1
Not at all
2
3
4
5
Perfectly
15
Q

If user documentation is being exported electronically what is the best type of file format to use and provide an example?

A

It is best to export the document to a platform independent file format, such as Portable Document Format (.PDF)

How well did you know this?
1
Not at all
2
3
4
5
Perfectly
16
Q

What are the features of the PDF file format?

A

PDF has applications, operating system, and hardware independence

PDF files are by default non-editable in viewer applications

PDF files are also faster to open due to it not catering for editing requirements

How well did you know this?
1
Not at all
2
3
4
5
Perfectly
17
Q

Outline the process of converting paper-based manuals to electronic versions

A

Scan the document into the computer using Optical Character Recognition (OCR) software that makes required alterations and then exports the documents as a PDF.

Alternatively can be re-written using HTML and distributed as a web page.

How well did you know this?
1
Not at all
2
3
4
5
Perfectly
18
Q

What are the two places that documentation can be distributed on/with?

A

Internet & Intranet (Depends on the requirements of the client and their business)

How well did you know this?
1
Not at all
2
3
4
5
Perfectly
19
Q

Outline when and why documentation may be distributed on the internet.

A

Distributing user documentation on the internet allows access to anyone wishing to use the manual.

How well did you know this?
1
Not at all
2
3
4
5
Perfectly
20
Q

Outline the use of the intranet for distributing documentation.

A

User Documentation may be distributed on the intranet if it is for a work-place specific application.

How well did you know this?
1
Not at all
2
3
4
5
Perfectly
21
Q

What are the advantages of using the internet to distribute documentation?

A

The internet is a very affective way for a business to reach their client.

How well did you know this?
1
Not at all
2
3
4
5
Perfectly
22
Q

What are the advantages of using the intranet to distribute user documentation?

A

Only accessible from within the organisation (helps keep secure)

Prevents sensitive business practices from being leaked

Easy to access documents (convenient)

How well did you know this?
1
Not at all
2
3
4
5
Perfectly
23
Q

The four main types of user documentation include:

A

Online help, training manuals, user manuals, and procedure manuals

How well did you know this?
1
Not at all
2
3
4
5
Perfectly
24
Q

Outline Online Help Documentation.

A

Online help files are electronic documentation files, created with HTML and works similarly to a web browser. Comes packaged with applications.

25
Q

How is Online help documentation usually stored?

A

Online help documentation is regularly stored as a single file called a Compiled HTML file, using the extension .chm

26
Q

Outline training manuals documentation

A

A type of user documentation that focuses on how to complete a range of tasks with a piece of software rather than trying to show all its features.

27
Q

Outline User Manuals.

A

More fully featured manuals that include all features of an application, however they may not go into the same depth for specific tasks when compared to a training manual.

28
Q

Outline Procedure Manuals

A

A manual that often provides detailed, step by step instructions on how to complete a particular task. May include images to provide further guidance. Usually cover a narrow range of topics but go into great depth.

29
Q

Outline Industry Standards

A

Standards set by organisations such as the international standards organisation (ISO) or Standards Australia (AS)

These are standards that apply internationally (ISO) or Australia Wide (AS) for entire industries.

30
Q

Outline Organistational Standards

A

Standards created by a workplace outlining how their documentation should be designed. May include aspects such as logos and formatting. Apply across an entire organisation and help to maintain consistency across multiple pieces of documentation a company provides.

31
Q

Outline Project Standards

A

Standards related to a single project. Standards created for the user documentation of a particular project in an organisation.

32
Q

Who may benefit most from paper based documentation such as user manuals, booklets, flowcharts, and quick reference guides?

A

Novice and Intermediate users

33
Q

What are two benefits of using paper based user documentation?

A

The user does not require a device, power or internet

The documentation is easy to access and can be easily annotated

34
Q

Who may benefit most from electronic user documentation such as Online guides, Video tutorials, forums, and presentations?

A

Intermediate, Expert, and Transfer

35
Q

Outline the benefits of using electronic user documentation.

A 
Easier to navigate
Always available (assuming internet and power)
Less  susceptible to damage
Can be adjusted
Can be stored
Can be easily  updated/edited
Can be accessed on multiple devices
Videos and other media can be used to support the user.
36
Q

Outline the disadvantages of using paper based user documentation.

A

Easily destroyed
More time consuming/expensive
Not environmentally friendly
Cannot be easily updated/changed

37
Q

Outline the disadvantages of using electronic user documentation.

A

Can be shared/copied/edited without permission
Need a device
May need large file size with bandwidth

38
Q

What are the two types of guidelines for the creation of user documentation?

A

Style Guides, Templates

39
Q

What is the use of a Style Guide?

A

To provide information about the formatting of documentation.

40
Q

What are some things a Style Guide may provide information on?

A 
Font
Headings
Text size
Letter spacing
Indentation
Line spacing
Justification
Paragraph spacing
Italics/Bold/Underline
Page Margins
Dot points/lists
Industry Abbreviations
41
Q

What is a Template?

A

A one-page document indicating where text objects will be placed on a page. It is based on the design elements specified in the Style Guide.

42
Q

What does effective User Documentation make use of?

A 
Correct punctuation 
Use of correct spelling and grammar
Writing concisely
An active voice
Positive Statements
43
Q

What is an Active voice?

A

Where the subject of the sentence is performing an action. Makes it stronger and more concise.

44
Q

What are Positive Statements?

A

Where rather than telling the user what not to do, it is better to tell them what to do

45
Q

Why are Policies and Procedures required when creating user documentation?

A

In order to ensure the design and development process runs smoothly.

46
Q

What policies and procedures are included when creating user documentation?

A 
Cataloguing 
Sign-off
Storage
Distribution
Revision
47
Q

What is cataloguing?

A

How will the document be organised? (eg chapters, sections, etc)

48
Q

What does Sign-off refer to?

A

Who will be given the authority at various stages to sign off each stage of the documentation?

49
Q

What does Storage outline?

A

How the documentation will be named, stored, and backed up.

50
Q

What does Distribution outline?

A

How the documentation will be distributed during production to ensure security and how after being complete

51
Q

What does Revision outline?

A

How and when the documentation will be revised, and who by?

52
Q

What is Version Control?

A

How updates/changes to documentation are managed

53
Q

What is best practice when creating user documentation (Version control)

A

Include the version of the document in the footnote and file name of the documentation.

54
Q

True/False

Numbers should always be used rather than letters

A

True, as there may be more than 26 versions

55
Q

What are the four steps when producing user documentation?

A

Gather information
Create the documentation
Have the document reviewed
Obtain approval and sign-off

56
Q

Outline the first step of producing user documentation

A 
Gather information
Think about aspect such as:
-The process
-Who is responsible for creating the documentation
-Who will approve the final version 
-Who is the target audience
-How will it be distributed
-What sources of information will be used
57
Q

Outline the second step of producing user documentation.

A

Create user documentation

  • Draft versions
  • Version control
58
Q

Outline the third step of producing user documentation

A

Review User Documentation

  • Check accuracy of instructions/text/screenshots
  • Give/receive feedback
59
Q

Outline the fourth step of producing user documentation.

A

Obtain Approval and Sign-off

Once a final document is produced, the person nominated for sign-off needs to approve the final version

Creating User Documentation (1 decks)

Brainscape helps you reach your goals faster, through stronger study habits.
© 2024 Bold Learning Solutions. Terms and Conditions