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.
What you are going through is more or less how I got into techwriting. As
long as you have the right intellectual equipment, adaptability, and a touch
of the boldness, you'll be fine. (Just by way of comparison, my formal
training consists of a background in medieval history and a postgrad IT
diploma.)
Though your organisation might have been wiser to get in an experienced
professional, for you, this could be an opportunity to get into techwriting
( if that's what you want to do). Either way, you're obviously stuck with
the role. So here goes by groat's worth...
It's true that really good techwriting at high-speed takes skill and
experience. However you can manage something adequate at a slower rate - and
better than a lot of the rubbish that's around - simply by 1. Knowing the
product you're documenting and in its context (e.g. who's using it and for
what) 2. Getting the hang of whatever tool you're using (and make sure you
have a sensible tool for the job) 3. Learning to write effective
instructions 4. Learning to structure your information logically. You'll
probably do all four at once.
Regarding #2 and #4, you should probably right-away read the Sun Style Guide
("Read Me First! A Style Guide for the Computer Industry" which will tells
you most of what you need to know to get started, and the "Microsoft Manual
of Style for Technical Publications" for specific issues. As I recall, also
good is the techwriting book in the For Complete Idiot's series.
In general, don't get bogged down with theory or processes, and don't be
intimidated by grammar since you'll be using a very small subset of it
If you want to vent, or ask specific questions along the way, please feel
free to mail me offline. (Everybody else, if you want to take issue, please
de-lurk and do so online since this is my work email)
Good luck
Martin
"Richard Sanchez" <richardsan2000 -at- yahoo -dot- com> wrote in message news:150507 -at- techwr-l -dot- -dot- -dot-
>
> Hello,
>
> I have been asked to write an Instruction Manual for a
> web-based customer service management type system. I
> have been asked, because no one else has time and I
> seemed like a good canidate. I have no formal training
> in tech writing. I am wondering if anyone can direct
> me to a good resource for learning about writing
> step-by-step instructions for using software. The end
> product is going to be web-based with graphics showing
> various screens in the application. Where does one
> begin with this type of task?
>
> Signed,
> Eyes glazing over
>
> __________________________________________________
> Do You Yahoo!?
> Yahoo! Tax Center - online filing with TurboTax
>http://taxes.yahoo.com/
>
>
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
Are you using Doc-to-Help or ForeHelp? Switch to RoboHelp for Word for $249
or to RoboHelp Office for only $499. Get the PC Magazine five-star rated
Help authoring tool for less! Go to http://www.ehelp.com/techwr
Free copy of ARTS PDF Tools when you register for the PDF
Conference by April 30. Leading-Edge Practices for Enterprise
& Government, June 3-5, Bethesda,MD. www.PDFConference.com
---
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.
