Re[2]: Documenting A Moving Target

Subject: Re[2]: Documenting A Moving Target
From: Kristina Ricks <kristina_ricks -at- MAIL -dot- MEDICALOGIC -dot- COM>
Date: Wed, 21 Feb 1996 11:58:58 PST

Interesting thread... generally part of the deal (in my experience) in
software writing.

One thing I found helped in my previous job was that I got the job of
writing error messages. This accomplished several things:

* The programmers were glad to pass it off to someone else... many of
them dreaded the task of writing these messages.

* I got my hands somewhat into the UI... at least as far as the
language of the messages goes.

* I had a view into what was changing where in the interface. I had to
sit down with the programmers and they would explain the situation,
the error condition, and why/where/how the error would take place.
From these conversations, I could usually see what else was changing,
and how that would affect all the documents.

* It meant that all messages had to be "externalized" (referenced in a
separate message file, not imbedded in the code), which is usually a
requirement if the product will ever be translated into another
language.

I'm currently lobbying to get this job in my new workplace. If all
works well, I'll be the designated error message person, and
communicate the UI changes I discover to the rest of the documentation
staff.

Tina Ricks


Previous by Author: Editorial Eye info
Next by Author: New Jersey Career Night: 2/29/96
Previous by Thread: Re: Documenting A Moving Target
Next by Thread: Re: Documenting A Moving Target


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

Sponsored Ads


Sponsored Ads