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.
Subject:Re: No users! From:John Posada <john -at- TDANDW -dot- COM> Date:Tue, 9 Feb 1999 12:17:23 -0500
Bev:
We don't name my documents based on the target...we base the name on the
purpose.
Following is a sample of the names of some of our documents:
System Acceptance Test Manual
System Trouble Locating Manual
Workstation Software Installation and Retrofit Guide
Hardware Growth Procedures Manual
By naming based on function, we avoid the problem of what audience to
target. We don't care whether they are users, clients, customers,
developers, etc. If they need the document based on what they need to
do, that's all we need to know.
Parks, Beverly wrote:
>
> This is one of those silly questions, but I'm going to ask it anyway. The
> decision has already been made to no longer refer to the users of our
> software as "users"; now they are "clients". OK. So I'm updating the
> manual and in the process changing users to clients. No problem. But then it
> hits me: the manual is titled "CIS Users Guide". To me, "CIS Clients Guide"
> sounds not only arrogant, but a wee bit stupid, too. Someone suggested "CIS
> Operations Guide", but that sounds like a flashback to mainframe days. The
> very simple "CIS Guide" doesn't seem to say enough.
>
> The software and documentation are internal products, so there are no
> marketing concerns. There's also no hardcopy manual, it's all web-based. Any
> suggestions? Reply directly so as not to clog the list with stuff that's of
> interest only to me. :)
>
> "CIS Instruction Manual" just popped into my head as I was re-reading this
> before sending. That may be the obvious solution, but I'd still like to hear
> other suggestions if you have them. Another one (why didn't these come to me
> yesterday?) that just came to me is "CIS Procedures Guide", which I like
> better than Instruction Manual. I think.
>
> Thanks.
>
> Bev Parks
> parksb -at- emh1 -dot- hqisec -dot- army -dot- mil
>
--
John Posada, Technical Writer
Bellcore, where Customer Satisfaction is our number one priority mailto:john -at- tdandw -dot- com mailto:jposada -at- notes -dot- cc -dot- bellcore -dot- com
phone(w) 732-699-3077 phone(h) 732-2910-7811
alpha-pager: 800-864-8444 pin 1857522 http://www.tdandw.com
email pager: mailto:1857522 -at- pagemart -dot- net
My opinions are mine, and neither you nor my company can take credit for
them.
"Give a man a fish and he will eat for a day. Teach him how to fish,
and he will sit in a boat and smoke cigars all day."
"The only perfect document I ever created is still on my hard drive."