|
1
|
|
|
2
|
- Owner, HyperTrain dot Com
- California-based, but do mostly onsite work, do lots of conferences
& talks
- Trained & consulted on Help Authoring
Tools and technologies – JavaScript, HTML, Interactivity,
CSS, DHTML, Web-based Help, etc. – since 1992ish
- Uncle Dave's motto: "Call me anytime." 888-722-0700,
dgash@hypertrain.com
|
|
3
|
- Scope
- Examine role of procedures, consider other information delivery devices
when procedures aren't appropriate
- Audience
- Hypertext authors at all levels
- Objectives
- To improve information delivery skills
- To improve the user's help experience
|
|
4
|
- Consultants and trainers stress them
- Partly practical (many help systems lack good procedures), partly
political (clients want efficiency and results)
- Many writers and managers don't even consider other information types
- "Users just need how-to s, right?"
- When time is short, procedures win
- "Ah, forget the secondary stuff; they won't read it anyway."
|
|
5
|
- Help should have plenty of procedures and they should be properly
formatted
- Topic title (gerund); often optional now
- See also device; offers quick navigation
- Conceptual element; introduces task
- Infinitive tag (to); often restates title
- Action statements; imperatives to user
- Feedback statements; ease surprises
- Special elements; tips, notes, cautions
|
|
6
|
- Elements present and used properly
|
|
7
|
- Command topics
- Overview topics
- Application sections, event sequence
- Error topics
- What happened & why, how to fix it, how to avoid it next time
|
|
8
|
- When other info creeps into procedures
|
|
9
|
- Problem #1: Embedded procedure info
|
|
10
|
- Problem #2: Irrelevant & unneeded info
|
|
11
|
|
|
12
|
- When other info is shown as a procedure
|
|
13
|
- Problem: This isn't a procedure!
|
|
14
|
|
|
15
|
- When good info goes totally bonkers
|
|
16
|
- Problem: Decent info, but all mixed up
|
|
17
|
- Problem: Decent info, but all mixed up
|
|
18
|
- Problem: Decent info, but all mixed up
|
|
19
|
- Problem: Decent info, but all mixed up
|
|
20
|
|
|
21
|
|
|
22
|
|
|
23
|
|
|
24
|
- Have plenty of procedures, but not only procedures
- Put the right information in the right topic types
- Make other information available, but not required, to get to procedures
- Let the user decide if & when to view other information
- Provide multiple access points to all information
|