help and documentation
DESCRIPTION
Help and Documentation. Agenda. User Support Requirements Types of doc/help User Support Approaches Presentation issues. User Support. Help Problem-oriented and specific Documentation System-oriented and general. Help & Documentation. Never a replacement for bad design, but essential - PowerPoint PPT PresentationTRANSCRIPT
![Page 1: Help and Documentation](https://reader035.vdocument.in/reader035/viewer/2022062217/56812de4550346895d933a8d/html5/thumbnails/1.jpg)
Help and Documentation
![Page 2: Help and Documentation](https://reader035.vdocument.in/reader035/viewer/2022062217/56812de4550346895d933a8d/html5/thumbnails/2.jpg)
2
Agenda
• User Support Requirements
• Types of doc/help
• User Support Approaches
• Presentation issues
![Page 3: Help and Documentation](https://reader035.vdocument.in/reader035/viewer/2022062217/56812de4550346895d933a8d/html5/thumbnails/3.jpg)
3
User Support
• Help– Problem-oriented and specific
• Documentation– System-oriented and general
![Page 4: Help and Documentation](https://reader035.vdocument.in/reader035/viewer/2022062217/56812de4550346895d933a8d/html5/thumbnails/4.jpg)
4
Help & Documentation
• Never a replacement for bad design, but essential
• Simple system
• Most other systems with rich features require help
![Page 5: Help and Documentation](https://reader035.vdocument.in/reader035/viewer/2022062217/56812de4550346895d933a8d/html5/thumbnails/5.jpg)
5
Documentation
• Kebanyakan user tidak suka membaca manual– Boring, no goal– start working
• Sering digunakan saat kondisi panik, ketika user membutuhkan bantuan secepatnya
![Page 6: Help and Documentation](https://reader035.vdocument.in/reader035/viewer/2022062217/56812de4550346895d933a8d/html5/thumbnails/6.jpg)
6
User Support Requirements
• Ketersediaan– Should be available any time the user is
operating the system
• Ketelitian & Kelengkapan– Should be accurate (tricky with changing
versions) and should cover all aspects of application
![Page 7: Help and Documentation](https://reader035.vdocument.in/reader035/viewer/2022062217/56812de4550346895d933a8d/html5/thumbnails/7.jpg)
7
User Support Requirements
• Konsisten– Across different sections, between on-line and
paper documentation, in terminology, content and style
• Ketahanan– Should be predictable and free of errors
![Page 8: Help and Documentation](https://reader035.vdocument.in/reader035/viewer/2022062217/56812de4550346895d933a8d/html5/thumbnails/8.jpg)
8
User Support Requirements
• Fleksibilitas– Mulai dari user awam sampai yg ahli
• Unobtrusiveness– Tidak mengacaukan
![Page 9: Help and Documentation](https://reader035.vdocument.in/reader035/viewer/2022062217/56812de4550346895d933a8d/html5/thumbnails/9.jpg)
9
Types of Doc/Help
• 1. Tutorial
• 2. Quick reference/review
• 3. Reference Manual (Full explanation)
• 4. Context-sensitive (task-specific) help
![Page 10: Help and Documentation](https://reader035.vdocument.in/reader035/viewer/2022062217/56812de4550346895d933a8d/html5/thumbnails/10.jpg)
10
Types of Doc/Help
• 1. Tutorial– For start-up– Gets user going– Convey conceptual model– Communicate essential items– Sometimes see on-line tour or demo– http://www.rsinc.com/envi/
![Page 11: Help and Documentation](https://reader035.vdocument.in/reader035/viewer/2022062217/56812de4550346895d933a8d/html5/thumbnails/11.jpg)
11
Types of Doc/Help
• 2. Quick reference/review– Reminder or short reference– Often for syntax– Can be recall aid for expert– Can allow novice to see what’s available– http://www.computerbooksonline.com/wproc/w
pdchap.htm– http://imbolc.ucc.ie/~pflynn//books/
htmlcard.html
![Page 12: Help and Documentation](https://reader035.vdocument.in/reader035/viewer/2022062217/56812de4550346895d933a8d/html5/thumbnails/12.jpg)
12
![Page 13: Help and Documentation](https://reader035.vdocument.in/reader035/viewer/2022062217/56812de4550346895d933a8d/html5/thumbnails/13.jpg)
13
Types of Doc/Help
• 3. Reference Manual (Full explanation)– Detailed command descriptions– Usually for experts– Unix on-line manual pages, for example– http://science.ksc.nasa.gov/shuttle/
technology/sts-newsref/stsref-toc.html
![Page 14: Help and Documentation](https://reader035.vdocument.in/reader035/viewer/2022062217/56812de4550346895d933a8d/html5/thumbnails/14.jpg)
14
Reference Manual
![Page 15: Help and Documentation](https://reader035.vdocument.in/reader035/viewer/2022062217/56812de4550346895d933a8d/html5/thumbnails/15.jpg)
15
Types of Doc/Help
• 4. Context-sensitive (task-specific) help– System provides help on current
situation– Macintosh balloon help, for
example– Other examples?
![Page 16: Help and Documentation](https://reader035.vdocument.in/reader035/viewer/2022062217/56812de4550346895d933a8d/html5/thumbnails/16.jpg)
16
User Support Approaches
• Command assistance– Detil spesifik pada command tertentu, seperti
MAN pada linux/unix– Bagus jika user tahu apa yg diinginkan
• Command prompts– Message ketika user melakukan kesalahan
![Page 17: Help and Documentation](https://reader035.vdocument.in/reader035/viewer/2022062217/56812de4550346895d933a8d/html5/thumbnails/17.jpg)
17
User Support Approaches
• Context-sensitive help– Knowledge of
particular user to information pertinent to a particular situation or interface item
Title bar
To move the window, position the pointer in the title bar,
press the button, and drag it to the new position
![Page 18: Help and Documentation](https://reader035.vdocument.in/reader035/viewer/2022062217/56812de4550346895d933a8d/html5/thumbnails/18.jpg)
18
User Support Approaches
Wizards• Takes user through procedure step by step• Inflexible, & often slow.• Also problematic if user gets stuck
![Page 19: Help and Documentation](https://reader035.vdocument.in/reader035/viewer/2022062217/56812de4550346895d933a8d/html5/thumbnails/19.jpg)
19
User Support Approaches
• On-line tutorials– Work through simple
examples, provide a feel for application
– http://w3.aces.uiuc.edu/AIM/scale/tutorials.html
– http://www.w3schools.com/
![Page 20: Help and Documentation](https://reader035.vdocument.in/reader035/viewer/2022062217/56812de4550346895d933a8d/html5/thumbnails/20.jpg)
20
User Support Approaches
• On-line documentation– How much like paper doc?– Electronic can emphasize hypertext, indexing,
and searching more– http://gcc.gnu.org/onlinedocs/
![Page 21: Help and Documentation](https://reader035.vdocument.in/reader035/viewer/2022062217/56812de4550346895d933a8d/html5/thumbnails/21.jpg)
21
Advantages of on-line help• Always available with the application - paper
manuals often unavailable• Don’t require extra desk space. • Electronically updated – fast & low cost • Electronic searching facilitates rapid location of
specific information • Can use graphics, sound, color, and animations
to explain complex functions • Can provide interactive & context specific help• Links to other on-line resources
![Page 22: Help and Documentation](https://reader035.vdocument.in/reader035/viewer/2022062217/56812de4550346895d933a8d/html5/thumbnails/22.jpg)
22
![Page 23: Help and Documentation](https://reader035.vdocument.in/reader035/viewer/2022062217/56812de4550346895d933a8d/html5/thumbnails/23.jpg)
23
Disadvantages of on-line help
• Reading screens always slower than paper
• Small displays require frequent page turning
• Display resolution less than printed material (v. important when graphics are used)
![Page 24: Help and Documentation](https://reader035.vdocument.in/reader035/viewer/2022062217/56812de4550346895d933a8d/html5/thumbnails/24.jpg)
24
Medium
• Paper versus monitor
• Studies show that people are 15-30% slower reading and comprehending text from a display as compared to paper
![Page 25: Help and Documentation](https://reader035.vdocument.in/reader035/viewer/2022062217/56812de4550346895d933a8d/html5/thumbnails/25.jpg)
25
Presentation Issues• Integrate with system, don’t “add on”• 1. How is help requested?
– Command, button, function, separate applic– Advantages, disadvantages?
• 2. How is help displayed?– Separate window, whole screen, part of screen, on
top of applic., pop-up box, command line, highlighted button, light bulb..
– Largely depends on what type of help it is
![Page 26: Help and Documentation](https://reader035.vdocument.in/reader035/viewer/2022062217/56812de4550346895d933a8d/html5/thumbnails/26.jpg)
26
Peluang?
• http://www.hci.com.au/
![Page 27: Help and Documentation](https://reader035.vdocument.in/reader035/viewer/2022062217/56812de4550346895d933a8d/html5/thumbnails/27.jpg)
27
Presentation Issues• 3. Effective presentation of help
– Design it like any other part of UI: language, terminology, jargon, etc.
– Use active voice• “To close a window, place the mouse cursor in the box at
the upper right corner (with the X) and click the mouse button.”
• 4. Implementation issues– Fast response time is important– How is help stored? File, database, …?