DITA has defined three basic Information Types to start with—Concept, Task, and Reference.
Users are task oriented. So, topics instructing the users to complete user tasks are of Task type. Task topics normally contain procedures to accomplish specific goals. Each Task topic covers one separate procedure.
Before performing the tasks, the users must know and build background knowledge about the product, the service, the module, the UI, the functionality and so on, to perform the tasks effortlessly. So, topics that educate and enable users to complete the tasks are of Concept type.
While performing the tasks, users may quickly need to refer some small bits of data and information. These information are normally organized and are central-reference points, feeding information to multiple tasks. These topics are of Reference type. Users typically look for reference material only when they need it, rather than trying to study and learn it as they do with Concepts. Reference topics provide brief statements of fact, not lengthy explanations. The data here is “looked up” often and not memorized once. Information contained in lists, tables, spec sheets, etc. are good examples of reference topics.
a) Concept
b) Task
c) Reference
2) What is the information type of the topic “Hospitals operating in Mumbai and their specialties”?
a) Concept
b) Task
c) Reference
3) What is the purpose the Concept information type solves?
a) To educate users about a product, service, or technology
b) To guide users to follow a procedure
c) To highlight key items in a product or service
4) Which of the following is a Reference type topic?
a) Closing the Wi-Fi connection
b) Error log file of ABC software
c) What makes a movie great
5) Do Concept, Task, and Reference topics complement each other in providing the whole set of information?
a) Yes
b) No
Users are task oriented. So, topics instructing the users to complete user tasks are of Task type. Task topics normally contain procedures to accomplish specific goals. Each Task topic covers one separate procedure.
Before performing the tasks, the users must know and build background knowledge about the product, the service, the module, the UI, the functionality and so on, to perform the tasks effortlessly. So, topics that educate and enable users to complete the tasks are of Concept type.
While performing the tasks, users may quickly need to refer some small bits of data and information. These information are normally organized and are central-reference points, feeding information to multiple tasks. These topics are of Reference type. Users typically look for reference material only when they need it, rather than trying to study and learn it as they do with Concepts. Reference topics provide brief statements of fact, not lengthy explanations. The data here is “looked up” often and not memorized once. Information contained in lists, tables, spec sheets, etc. are good examples of reference topics.
Example
A person bought a Solar Lamp from a XYZ company. He needs to test it to check whether it’s working well or not. Here is the analysis of some probable topics:
#
|
Topic name
|
What purpose it solves
|
Topic type
|
1
|
XYZ Solar Lamp specifications
|
Provides quick facts about the technicalities and features of the XYZ
solar lamp
|
Reference
|
2
|
About XYZ Solar Lamp
|
Educates about the XYZ solar lamp
|
Concept
|
3
|
Opening the Solar Lamp package safely
|
Instructs to open the solar lamp package safely
|
Tasks
|
4
|
Ensuring availability of all parts of the lamp in the package
|
Instructs to verify the availability of all needed parts
|
Task
|
5
|
XYZ Solar Lamp Parts
|
Provides a listing of all parts of the lamp
|
Reference
|
6
|
Charging the XYZ Solar Lamp
|
Instructs to charge the XYZ Solar Lamp
|
Task
|
7
|
Operating the Solar Lamp
|
Instructs to operate the XYZ Solar Lamp
|
Task
|
8
|
Making safe use of the lamp
|
Instructs to make safe use of the lamp
|
Task
|
9
|
Troubleshooting: Power button not working
|
Instructs to resolve the issue of dysfunctional power button
|
Task
|
10
|
Glossary
|
Lists names and descriptions of key terminologies used in other
topics
|
Reference
|
Where is the magic?
- Whatever information we find can be generically categorized as of Concept, Task, or Reference type.
- Concept, Task, and Reference types complement each other and together make a complete set of information that is easy to refer.
- There is a simple learning and analysis curve. Get to know the product and work with it by using only the required information.
- Concept, Task, or Reference types form the basis for lean and minimal documentation, as any extraneous information that is outside of this Concept/Task/Reference set, are not used anyway in practice.
- Defines foundation for the evolution of custom information types for organizations.
Further reading
- “Concept, Task, Reference: A Practical Guide to Choosing the Right Topic Type”; http://tc.eserver.org/35431.html
Practice assignment
- Prepare the outline of the User Guide for a Wireless Mouse, and categorize the included topics as Concepts, Tasks, or References.
Quizzes:
1) A topic titled as “Executive Summary”, should be of what topic type?a) Concept
b) Task
c) Reference
2) What is the information type of the topic “Hospitals operating in Mumbai and their specialties”?
a) Concept
b) Task
c) Reference
3) What is the purpose the Concept information type solves?
a) To educate users about a product, service, or technology
b) To guide users to follow a procedure
c) To highlight key items in a product or service
4) Which of the following is a Reference type topic?
a) Closing the Wi-Fi connection
b) Error log file of ABC software
c) What makes a movie great
5) Do Concept, Task, and Reference topics complement each other in providing the whole set of information?
a) Yes
b) No
Answers:
[1 a, 2 c, 3 a, 4 b, 5 a]
No comments:
Post a Comment