peggy harvey eng 675 april 20, 2010. background problem initial concerns decisions and...
TRANSCRIPT
![Page 1: Peggy Harvey ENG 675 April 20, 2010. Background Problem Initial Concerns Decisions and Challenges Result What’s Next](https://reader031.vdocuments.net/reader031/viewer/2022020117/56649db35503460f94aa3c5f/html5/thumbnails/1.jpg)
Creating an Online Help System for Logical Ink
Peggy HarveyENG 675
April 20, 2010
![Page 2: Peggy Harvey ENG 675 April 20, 2010. Background Problem Initial Concerns Decisions and Challenges Result What’s Next](https://reader031.vdocuments.net/reader031/viewer/2022020117/56649db35503460f94aa3c5f/html5/thumbnails/2.jpg)
Background Problem Initial Concerns Decisions and Challenges
Result What’s Next
Agenda
![Page 3: Peggy Harvey ENG 675 April 20, 2010. Background Problem Initial Concerns Decisions and Challenges Result What’s Next](https://reader031.vdocuments.net/reader031/viewer/2022020117/56649db35503460f94aa3c5f/html5/thumbnails/3.jpg)
Logical Progression is a start-up company that provides tablet-based software solutions
Logical Ink is an electronic charting solution for healthcare
Background
![Page 4: Peggy Harvey ENG 675 April 20, 2010. Background Problem Initial Concerns Decisions and Challenges Result What’s Next](https://reader031.vdocuments.net/reader031/viewer/2022020117/56649db35503460f94aa3c5f/html5/thumbnails/4.jpg)
Provide documentation for the new version of Logical Ink Server
Prior versions were configured by Logical Progression staff
New version is a Web portal intended to give end users access to the server backend
Help system integrated into product more likely to be used by audience
Problem
![Page 5: Peggy Harvey ENG 675 April 20, 2010. Background Problem Initial Concerns Decisions and Challenges Result What’s Next](https://reader031.vdocuments.net/reader031/viewer/2022020117/56649db35503460f94aa3c5f/html5/thumbnails/5.jpg)
I’m not a Logical Progression employee.
I’m not regularly on site. Disconnect between the Logical Ink Server development schedule and my ENG 675 deadlines.
Initial Concerns
![Page 6: Peggy Harvey ENG 675 April 20, 2010. Background Problem Initial Concerns Decisions and Challenges Result What’s Next](https://reader031.vdocuments.net/reader031/viewer/2022020117/56649db35503460f94aa3c5f/html5/thumbnails/6.jpg)
Chris was very supportive of my project and wanted me to succeed.
Chris provided information whenever I needed it.
For ENG 675, I developed the Help system completely from the product specification.
Initial Concerns Alleviated
![Page 7: Peggy Harvey ENG 675 April 20, 2010. Background Problem Initial Concerns Decisions and Challenges Result What’s Next](https://reader031.vdocuments.net/reader031/viewer/2022020117/56649db35503460f94aa3c5f/html5/thumbnails/7.jpg)
Type of Help system? Level of quality? Design elements? Navigation elements? Content to include or exclude?
What…
![Page 8: Peggy Harvey ENG 675 April 20, 2010. Background Problem Initial Concerns Decisions and Challenges Result What’s Next](https://reader031.vdocuments.net/reader031/viewer/2022020117/56649db35503460f94aa3c5f/html5/thumbnails/8.jpg)
Help system: HTML Help Quality: Basic, version 1.0 (ENG 518) Design: Simple (ENG 517, ENG 508) Navigation: Cross-references, hyperlinks, index
Decisions
![Page 9: Peggy Harvey ENG 675 April 20, 2010. Background Problem Initial Concerns Decisions and Challenges Result What’s Next](https://reader031.vdocuments.net/reader031/viewer/2022020117/56649db35503460f94aa3c5f/html5/thumbnails/9.jpg)
Focus on what users need (ENG 512) Usable, useful content (ENG 508) Task-centered, minimalist approach based on user scenarios (ENG 518)
Effective information architecture (ENG 518)
Consistency to accommodate non-linear format
Content
![Page 10: Peggy Harvey ENG 675 April 20, 2010. Background Problem Initial Concerns Decisions and Challenges Result What’s Next](https://reader031.vdocuments.net/reader031/viewer/2022020117/56649db35503460f94aa3c5f/html5/thumbnails/10.jpg)
How much contextual information do users need?
What level of detail should be included?
What kind of information are users looking for?
Challenge: No Usability Studies
![Page 11: Peggy Harvey ENG 675 April 20, 2010. Background Problem Initial Concerns Decisions and Challenges Result What’s Next](https://reader031.vdocuments.net/reader031/viewer/2022020117/56649db35503460f94aa3c5f/html5/thumbnails/11.jpg)
Creating a Help system requires authoring tools
Incorporate best practices Wanted to use a long-term, maintainable process
How…
![Page 12: Peggy Harvey ENG 675 April 20, 2010. Background Problem Initial Concerns Decisions and Challenges Result What’s Next](https://reader031.vdocuments.net/reader031/viewer/2022020117/56649db35503460f94aa3c5f/html5/thumbnails/12.jpg)
Effectively building a tech comm department on my own
Had to develop the entire documentation process from the ground up
Challenge #1: No Precedent
![Page 13: Peggy Harvey ENG 675 April 20, 2010. Background Problem Initial Concerns Decisions and Challenges Result What’s Next](https://reader031.vdocuments.net/reader031/viewer/2022020117/56649db35503460f94aa3c5f/html5/thumbnails/13.jpg)
XML architecture “Chunks” information into individual topics
Single-sourcing Reuse Human-readable files
DITA – Darwin Information Typing Architecture
![Page 14: Peggy Harvey ENG 675 April 20, 2010. Background Problem Initial Concerns Decisions and Challenges Result What’s Next](https://reader031.vdocuments.net/reader031/viewer/2022020117/56649db35503460f94aa3c5f/html5/thumbnails/14.jpg)
DITA is complicated and very difficult to learn on your own
Didn’t know where to start Tried to learn Structured FrameMaker interface at same time
Eventually ran out of time
Challenge #2: DITA
![Page 15: Peggy Harvey ENG 675 April 20, 2010. Background Problem Initial Concerns Decisions and Challenges Result What’s Next](https://reader031.vdocuments.net/reader031/viewer/2022020117/56649db35503460f94aa3c5f/html5/thumbnails/15.jpg)
After DITA failed, still had learning curve with backup solution
Needed to re-teach myself FrameMaker
Dealt with technological issues as they came
Challenge #3: Tools
![Page 16: Peggy Harvey ENG 675 April 20, 2010. Background Problem Initial Concerns Decisions and Challenges Result What’s Next](https://reader031.vdocuments.net/reader031/viewer/2022020117/56649db35503460f94aa3c5f/html5/thumbnails/16.jpg)
Working, functional Help system based on the product specification
Lack of user data means Help system 1.0 is in effect a test system
Result
![Page 17: Peggy Harvey ENG 675 April 20, 2010. Background Problem Initial Concerns Decisions and Challenges Result What’s Next](https://reader031.vdocuments.net/reader031/viewer/2022020117/56649db35503460f94aa3c5f/html5/thumbnails/17.jpg)
Match Help system to the actual product
Add context-sensitive hooks Usability testing on product and documentation
Hand-off of source files to Logical Progression
What’s Next?
![Page 18: Peggy Harvey ENG 675 April 20, 2010. Background Problem Initial Concerns Decisions and Challenges Result What’s Next](https://reader031.vdocuments.net/reader031/viewer/2022020117/56649db35503460f94aa3c5f/html5/thumbnails/18.jpg)
Thank You