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.
Re: What shall I do when faced with this situation
Subject:Re: What shall I do when faced with this situation From:Debra Crum <debbi -dot- crum -at- gmail -dot- com> To:Simon <wingman1985 -at- yahoo -dot- com -dot- cn> Date:Mon, 8 Jul 2013 08:38:49 -0400
Is there a specification you can look at? That can tell you what the
product is designed to do. It can also give you information on the hardware
configuration. In my industry this would be information such as the number
and type of inputs & outputs, communication methods (Ethernet? radio?
cellular?), and power requirements (battery backup?).
A test engineer is also a good source of information once the product goes
into its alpha and beta stages. Test engineers can show you the actual
product and give you information on how it will be installed, how the end
user will use it, and troubleshooting steps for installers and users when
things don't go as planned. I've found that the test engineer has become my
best friend :)
Attending the meetings is a big plus, since you'll be kept up to date on
any changes that occur.
Debbi
On Mon, Jul 8, 2013 at 12:48 AM, Simon <wingman1985 -at- yahoo -dot- com -dot- cn> wrote:
> I have been asked to attend developers meeting(non-software industry) and
> to help with their documentation effort(They are also responsible for
> producing manual which is much of an annoyance to them). I collect as much
> information as I can(their meeting memo and everything I can get such as
> drawings and so on) .
>
>
> For those who work in the manufacturing side of technical doc world, can
> you offer some advice on how I can collect necessary input and "help"
> (verbatim from the engineering director)with the doc.
>
>
> ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
> New! Doc-to-Help 2013 features the industry's first HTML5 editor for
> authoring.
>
> Learn more: http://bit.ly/ZeOZeQ
>
> ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
>
> You are currently subscribed to TECHWR-L as debbi -dot- crum -at- gmail -dot- com -dot-
>
> To unsubscribe send a blank email to
> techwr-l-leave -at- lists -dot- techwr-l -dot- com
>
>
> Send administrative questions to admin -at- techwr-l -dot- com -dot- Visit
>http://www.techwhirl.com/email-discussion-groups/ for more resources and
> info.
>
> Looking for articles on Technical Communications? Head over to our online
> magazine at http://techwhirl.com
>
> Looking for the archived Techwr-l email discussions? Search our public
> email archives @ http://techwr-l.com/archives
>
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
New! Doc-to-Help 2013 features the industry's first HTML5 editor for authoring.
