User and technical documentation
Name:
Date:
Class:
A
Quick Questions
Shade in the A or B circle for each question.
1. Who is user documentation written for?
2. Which document is technical documentation?
3. Which statement about external documentation is correct?
4. A new developer must update a program next year. Which document helps most?
5. A user wants to know how to save their work. Where should they look?
B
Match the Pairs
Draw a line connecting each item on the left to its match on the right.
| Left column | Right column | |
|---|---|---|
| 1User documentation | AA user guide or manual that shows users how to install and operate the program | |
| 2Technical documentation | BDesign documents such as flowcharts and pseudocode are technical documentation for developers, not instructions for users. | |
| 3A document written for end users that explains how to use the program | CDesign document: flowchart + pseudocode + test results | |
| 4A document written for developers that records the design of the program | DUser manual: 1. Open the app. 2. Click Add Task. | |
| 5Give the user a flowchart and pseudocode of the program to learn how to operate it | EA user manual is user documentation. Technical documentation should hold design records such as pseudocode, flowcharts and test results. | |
| 6Put the step-by-step user manual in the technical documentation so a developer can fix the code | FRecords of the design and structure, such as pseudocode, flowcharts and test results, for developers |
C
Definitions
external documentation
D
Fill in the Blanks
Complete each line of code by filling in the missing parts.
1.
____ documentation: user guide or manual
2.
_________ documentation: for developers
3.
user documentation audience: _________
4.
technical documentation includes __________
5.
technical documentation:
pseudocode, flowcharts, ____________
E
Spot the Error
Shade in the letter of the line that contains an error.
Question 1
A
docType <- "user guide"
B
audience <- "developer"
C
content <- "how to log in"
D
print docType
Question 2
A
docType <- "user guide"
B
audience <- "developer"
C
content <- "flowchart"
D
print audience
Question 3
A
define chooseDoc(need)
B
if need = "how to use" then
C
return "technical doc"
D
else
E
return "technical doc"
Question 4
A
docType <- "user guide"
B
audience <- "customer"
C
include <- "test results"
D
print include
Question 5
A
docType <- "technical doc"
B
audience <- "developer"
C
print "Design: pseudocode"
D
print "Steps: click Start"
Answer Key
User and technical documentation
Section A: Quick Questions
Q1
A — The people who will operate the program
Q2
A — A flowchart showing the program's design
Q3
A — It is supplied with the program, separate from the code
Q4
B — Technical documentation with pseudocode and test results
Q5
B — The user guide or manual
Section B: Match the Pairs
Q1
User documentation → A user guide or manual that shows users how to install and operate the program
Q2
Technical documentation → Records of the design and structure, such as pseudocode, flowcharts and test results, for developers
Q3
A document written for end users that explains how to use the program → User manual: 1. Open the app. 2. Click Add Task.
Q4
A document written for developers that records the design of the program → Design document: flowchart + pseudocode + test results
Q5
Give the user a flowchart and pseudocode of the program to learn how to operate it → Design documents such as flowcharts and pseudocode are technical documentation for developers, not instructions for users.
Q6
Put the step-by-step user manual in the technical documentation so a developer can fix the code → A user manual is user documentation. Technical documentation should hold design records such as pseudocode, flowcharts and test results.
Section C: Definitions
Q1
external documentation — Documents supplied with a program: user documentation guides users to operate it; technical documentation records design (pseudocode, flowcharts, test results) for developers.Section D: Fill in the Blanks
Q1
user documentation: user guide or manualQ2
technical documentation: for developersQ3
user documentation audience: end usersQ4
technical documentation includes flowchartsQ5
technical documentation:
pseudocode, flowcharts, test resultsSection E: Spot the Error
Q1
B — A user guide is written for end users who operate the program, not for developers. The line should be audience <- "end user".
Q2
A — The audience is a developer and the content is a flowchart, so this is technical documentation. The first line should be docType <- "technical doc".
Q3
C — Someone who needs to learn how to use the program needs the user guide. Technical documentation is for developers. The line should be return "user guide".
Q4
C — Test results record how the program was designed and tested, so they belong in technical documentation. A user guide should include steps such as "login steps".
Q5
D — Technical documentation records design and test results for developers. Instructions such as 'click Start' belong in a user guide. The line should be print "Tests: results table".