TechWhirl (TECHWR-L) is a resource for technical writing and technical communications professionals of all experience levels and in all industries to share their experiences and acquire information.
For two decades, technical communicators have turned to TechWhirl to ask and answer questions about the always-changing world of technical communications, such as tools, skills, career paths, methodologies, and emerging industries. The TechWhirl Archives and magazine, created for, by and about technical writers, offer a wealth of knowledge to everyone with an interest in any aspect of technical communications.
Subject:Re: Help wanted for a newbie Technical Writer From:"Jane Bergen" <jane -dot- bergen -at- usa -dot- net> To:"TECHWR-L" <techwr-l -at- lists -dot- raycomm -dot- com> Date:Thu, 7 Dec 2000 08:35:13 -0600
Abhay,
What you are asking is way beyond the scope of this list. No one can know
all the environmental variables, your skill levels, and your company's
requirements to tell you how to "start from scratch." Here are a few
pointers to consider:
* Work through the RoboHelp tutorial (by the way, that version is old.
Version 9.1 is now out) and learn the basics.
* Find some books and learn from them. The techwr-l web site has a
suggested list (see the URL at the bottom of this message). Since you
don't say what kind of help files you're supposed to use (WinHelp or
HTMLHelp or WebHelp), I won't belabor the list with specific
recommendations.
* Ask your boss to send you to training class. You don't say where you're
located, but you might try looking for a local STC chapter if you're in
the U.S. to see if they have workshops, etc.
* Look at some good sample systems to make sure you understand what makes
a good online help system. Some of the books will help you (just offhand,
I can recommend three: "Standards in Online Documentation" by J. Hackos
and D. Stevens, "Writing and Designing Online Help" [2nd ed.] by William
Horton, and "Designing Online Help for Windows 95" by M. Deaton and C.
Lockett Zubak [this last one is a little dated but would be helpful
anyway])
Good luck.
Jane Bergen
----- Original Message -----
From: "suresh skr" <abhayksr2000 -at- yahoo -dot- com>
To: "TECHWR-L" <techwr-l -at- lists -dot- raycomm -dot- com>
Sent: Wednesday, December 06, 2000 2:19 PM
Subject: Help wanted for a newbie Technical Writer
> Hi all,
>
> I am a newbie in Technical Writing and also have
> joined the list just now. My company has asked me to
> document a product, which includes creating online
> help for the product.
>
> My company has RoboHelp software (version 7.00.139)
> plus the Office 97 and using them I have to create the
> online help. This is my first project and there are no
> technical writers around in the company. Keeping this
> in view can someone help me to start the work
> from a scratch?
>
> Thanks in advance for all.
>
> Abhay
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
Develop HTML-based Help with Macromedia Dreamweaver! (STC Discount.)
**NEW DATE/LOCATION!** January 16-17, 2001, New York, NY. http://www.weisner.com/training/dreamweaver_help.htm or 800-646-9989.
Take XML and Tech Writing courses online! Our instructor-led courses
(4-6 hrs/wk) give you "hands on" experience at your convenience. STC members
get 20% off! http://www.online-learning.com/index.html.
---
You are currently subscribed to techwr-l as: archive -at- raycomm -dot- com
To unsubscribe send a blank email to leave-techwr-l-obscured -at- lists -dot- raycomm -dot- com
Send administrative questions to ejray -at- raycomm -dot- com -dot- Visit http://www.raycomm.com/techwhirl/ for more resources and info.