RE: Writing software documentation without the software

["Robotti, Anne \(Carlin\)" <ARobotti -at- CarlinGroup -dot- com>]

> I've informed my manager that trying to write software 
> documentation without the software is like writing a cookbook 
> without testing the recipes.  He hasn't gotten back to me 
> yet, and I need some advice about making my case.  I'm sure 
> I'll be called for a meeting this afternoon.

Hi Russel,

I've been in a situation where the SMEs just couldn't (wouldn't?) free
up the resources to get me hooked up - sometimes because it would
involve creating a test bed, sometimes there are licensing issues with
non-proprietary components, sometimes there were network issues,
whatever.

I created a "Questions" text condition in Frame that turned the text
blue and bolded it. Then I just worked off my outline, filling in as
much as I could and inserting "Need screen shot here" or "Then what?" or
"What if they just want to print it?" or whatever my question was. So
all the questions stood out in bold blue.

Something I didn't always have time to do, but which made things much
easier, was to quickly summarize in an email which screen shots were
missing and which procedures I still had questions on. I think it kept
it fresh in the SME's mind so that if he was doing that thing I had a
question on he could call me and say, "Hey, do you want to see the XYZ
run?"

Not that you shouldn't try to get access to the software, but if you
can't there are ways you can make it easier on everybody.

Anne


----------------------------------------------------------------------

Carlin Equities and its affiliates? (Carlin) e-mail systems are for business purposes only. Messages are not confidential.  Authorized supervisors, compliance personnel, or internal auditors may review all e-mail.  E-mail will be archived for at least three years and may be produced to regulatory agencies or others with a legal right to access such information.  Carlin will not accept trade order instructions via e-mail.  Please telephone your firm representative or the Order Room to place trade orders.

Please be advised that any discussion of U.S. tax matters contained within this communication, including any attachment, cannot be used for the purpose of avoiding U.S. tax-related penalties or promoting, marketing, or recommending to another party any transaction or matter addressed herein.

----------------------------------------------------------------------^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^

WebWorks ePublisher Pro for Word features support for every major Help 
format plus PDF, HTML and more. Flexible, precise, and efficient content 
delivery. Try it today! http://www.webworks.com/techwr-l

Create HTML or Microsoft Word content and convert to Help file formats or 
printed documentation. Features include single source authoring, team authoring,
Web-based technology, and PDF output. http://www.DocToHelp.com/TechwrlList

---
You are currently subscribed to TECHWR-L as archive -at- infoinfocus -dot- com -dot- 

To unsubscribe send a blank email to 
techwr-l-unsubscribe -at- lists -dot- techwr-l -dot- com
or visit http://lists.techwr-l.com/mailman/options/techwr-l/archive%40infoinfocus.com


To subscribe, send a blank email to techwr-l-join -at- lists -dot- techwr-l -dot- com

Send administrative questions to admin -at- techwr-l -dot- com -dot-  Visit
http://www.techwr-l.com/techwhirl/ for more resources and info.