[Author Prev][Author Next][Thread Prev][Thread Next]
[Author Index (this month)][Thread Index (this month)][Top of Archive]

Re: Documenting Hardware....yikes

Subject: Re: Documenting Hardware....yikes
From: Dick Margulis <margulisd -at- comcast -dot- net>
To: "TECHWR-L" <techwr-l -at- lists -dot- techwr-l -dot- com>
Date: Fri, 01 Apr 2005 13:23:45 -0500




Leanne Rollins wrote:

> So, what I'm looking for is any tips from the h/w pros that I can use
in my
Wednesday meeting. What is the most expeditious method, in your experience,
of creating an install procedure for a system that is all put together (and
it's huge, so it can't just be stripped down and put back together) with
nary a thought to recreating it? I realize I need to get my hands on any
requirements docs (assuming they have them) and any design drawings. Other
than that, how do I make the best use of my 2 hours?

Camcorder on a tripod. Digital voice recorder for backup. Have the engineers perform as many relevant procedures on the machine as you have time for (okay, you may have to take the camcorder off the tripod when they walk around to the back of the machine). Focus on step-by-step procedures as much as possible, but if someone wants to do ten minutes at the whiteboard on theory of operation, don't turn 'em down.



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

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

---
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.


References:
RE: Displays vs. Appears: From: Jayaseelan Pannirselvam
Re: Displays vs. Appears: From: dmbrown
Documenting Hardware....yikes: From: Leanne Rollins

Previous by Author: Re: Technical Writing - What's the catch?
Next by Author: Re: Technical Writing - What's the catch?
Previous by Thread: Documenting Hardware....yikes
Next by Thread: RE: Displays vs. Appears

[Top of Archive] | [Author Index (this month)] | [Thread Index (this month)]

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

Sponsored Ads