RE: Timeframe for creating Online Help System

Subject: RE: Timeframe for creating Online Help System
From: "Neumann, Eileen" <ENeuman -at- franklintempleton -dot- ca>
To: "TECHWR-L" <techwr-l -at- lists -dot- techwr-l -dot- com>
Date: Thu, 13 Jan 2005 15:54:34 -0500


So you have 12 business days to deliver a large product, and you haven't yet decided on what your output will be, huh? Online help, PDF, word doc...

Nothing will be good. Don't worry about the format. For 12 days, you need a plan to produce something, anything.

What about 13 PDF files and a working indexing system from one HTML page? Maybe you could put all your huge :) amounts of time to use on developing a navigation system that will let the user find the file they need as easily as possible? That's not so easy in itself.

Forget Robo Help, ditch PDF also if necessary. I would try and do one thing to help, such as the navigation. Let your manager take any heat, and back him up as much as possible. You can't win this one.

My 2 cents,
Eileen Neumann



-----Original Message-----
From: Hamlett, Ashaki [mailto:Ashaki -dot- Hamlett -at- pfizer -dot- com]
Sent: Thursday, January 13, 2005 1:30 PM
To: TECHWR-L
Subject: Timeframe for creating Online Help System


I'm working as a contract technical writer that has been tasked to create a
user manual for a large, complex application. The current user manual is
stored as thirteen Word files. Each file is at least 20MB (due to the large
number of screen shots). When I joined the team, the other writer was going
to convert each Word file to a PDF, then merge all the PDFs into one file.
After much discussion, it was decided that this wasn't the most
user-friendly format. The user would literally be opening a 700 page file
and expected to find the procedures he/she needed. It was then decided that
we'd create an online Help system with RoboHelp that would enable the users
to easily search procedures and keywords. Well, now the other tech writer is
no longer here, so I'm writing all the documentation for the system. Based
on our time crunch, the manager would like for me to continue with our
original plan (Word files converted to a large PDF). This solution presents
a couple of problems: 1) the Word files are so large they are getting
corrupted; 2) the user is going to have to toggle through several hundred
pages of a PDF; and 3) the file is too large to e-mail to colleagues at
remote locations.

I don't feel comfortable creating a document that isn't usable, but I have
until February 1 to deliver a user manual. Is it realistic to create a help
system (not sure the number of topics) in this timeframe (I'd be using RH
X5)or do I just concede and deliver a 700 page PDF?

My goal is to talk to the manager today and voice my concerns with the
current strategy and I'd like to convince him that the PDF solution (even if
it's quicker) isn't the best. Has anyone else have to combat this problem?
All comments/suggestions are welcomed and appreciated.

Thanks,

Ashaki






Notice: All email and instant messages (including attachments) sent to
or from Franklin Templeton Investments (FTI) personnel may be retained,
monitored and/or reviewed by FTI and its agents, or authorized
law enforcement personnel, without further notice or consent.

^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^

WEBWORKS FINALDRAFT - EDIT AND REVIEW, REDEFINED
Accelerate the document lifecycle with full online discussions and unique feedback-management capabilities. Unlimited, efficient reviews for Word
and FrameMaker authors. Live, online demo:
http://www.webworks.com/techwr-l

Technical Communication Certificate online - Malaspina-University College, Canada. Online training in technical writing, software (FrameMaker, RoboHelp, Dreamweaver, Acrobat), document & web design, writing manuals, job search. www.pr.mala.bc.ca/tech_comm.htm for details.

---
You are currently subscribed to techwr-l as:
archiver -at- techwr-l -dot- com
To unsubscribe send a blank email to leave-techwr-l-obscured -at- lists -dot- techwr-l -dot- com
Send administrative questions to lisa -at- techwr-l -dot- com -dot- Visit
http://www.techwr-l.com/techwhirl/ for more resources and info.



Previous by Author: RE: Outsourcing in Earnest
Next by Author: RE: Timeframe for creating Online Help System
Previous by Thread: Re: Timeframe for creating Online Help System
Next by Thread: RE: Timeframe for creating Online Help System


What this post helpful? Share it with friends and colleagues:


Sponsored Ads