RE: Hardest part of getting started?

Subject: RE: Hardest part of getting started?
From: "Maggie Secara" <maggiros2 -at- home -dot- com>
To: "TECHWR-L" <techwr-l -at- lists -dot- raycomm -dot- com>
Date: Fri, 21 Sep 2001 10:31:01 -0700

As far as I can tell, these are the right things to start off any writer who's
new to your group, junior or senior. I've been at sea in places where these
things weren't clear, it it seemed that I was expected to already know them.
Sure, you can ask, but how much time are you comfortable spending to ask every
question separately when it could be taken care of up front!



Maggie Secara


Steven Brown said:

> Three things come to my mind, which are probably not
> unique to a junior writer.
>
> First, assuming most of us are left-brained, introduce
> the writer to the company's product line,
> organizational chart, and documentation set. I've
> always felt most comfortable with a new job when I
> understand the big picture BEFORE being given the
> departmental style guide or release notes to write.
>
> Second, outline and explain your workflow. How does
> the department (and subsequently, each writer) know
> what to work on? How is work assigned or prioritized?
> How does the software release process work? Where do I
> go or what systems do I use to access information to
> write release notes, system guides, install manuals,
> etc. Is there anything "quirky" about these processes
> ("A developer named Joe Smith is notorious for not
> documenting his bug fixes in the system, so you have
> to go into his folder on the network to find out
> exactly what he did.").
>
> Finally, when you first assign the writer his first
> task, be sure to fully explain your expectations so
> that he/she understands what needs to be documented,
> how much detail to include, how to structure the
> information, etc.
> >



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

A landmark hotel, one of America's most beautiful cities, and
three and a half days of immersion in the state of the art:
IPCC 01, Oct. 24-27 in Santa Fe. http://ieeepcs.org/2001/

+++ Miramo -- Database/XML publishing automation. See us at +++
+++ Seybold SFO, Sept. 25-27, in the Adobe Partners Pavilion +++
+++ More info: http://www.axialinfo.com http://www.miramo.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.


Follow-Ups:

References:
Re: Hardest part of getting started?: From: Steven Brown

Previous by Author: RE: Advice, please
Next by Author: RE: How many worthless stock options do you have?
Previous by Thread: Re: Hardest part of getting started?
Next by Thread: How many worthless stock options do you have?


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


Sponsored Ads