What to call a smallish document that describes a particular way to use a product?

Subject: What to call a smallish document that describes a particular way to use a product?
From: Melanie Albrecht <melanie -dot- albrecht -at- gmail -dot- com>
To: TECHWR-L Writing <techwr-l -at- lists -dot- techwr-l -dot- com>
Date: Thu, 24 Jul 2014 11:08:15 +1000

Hello people

I need help with naming some documents that I plan to write.

I write doc for an authentication server, which can work in lots of
different ways with lots of different systems.

I'll have the usual installation & config material in the usual books, plus
a bunch of small scenario-specific books, like this:


- Use Whatsit and OATH tokens to secure access to a VPN
- Use Whatsit as a RADIUS server with Checkpoint
- Use Whatsit with Telstra Gateway
- ...etc

At first there will be about five of these little docs, but I expect that
there might be twenty or fifty of them in a year or two.

What should I call these little documents? All I can think of "scenario
guide" and "use case guide", neither of which seems right. I need to be
able to say things like "Use the Installation Guide to set up Whatsit, and
then choose a ??? to help you configure it for your situation."

Thanks,
Melanie

^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
Read about how Georgia System Operation Corporation improved teamwork, communication, and efficiency using Doc-To-Help | http://bit.ly/1lRPd2l

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

You are currently subscribed to TECHWR-L as archive -at- web -dot- techwr-l -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


Follow-Ups:

Previous by Author: Re: Code for publishing PDF from Confluence
Next by Author: Re: What to call a smallish document that describes a particular way to use a product?
Previous by Thread: Re: _"Infographics_â_A_Special_Mode_of_Technical_Commun ication"
Next by Thread: RE: What to call a smallish document that describes a particular way to use a product?


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

Sponsored Ads


Sponsored Ads