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

Subject: Re: What to call a smallish document that describes a particular way to use a product?
From: Keith Hood <klhra -at- yahoo -dot- com>
To: Lynne Wright <Lynne -dot- Wright -at- tiburoninc -dot- com>, Melanie Albrecht <melanie -dot- albrecht -at- gmail -dot- com>, TECHWR-L Writing <techwr-l -at- lists -dot- techwr-l -dot- com>
Date: Thu, 24 Jul 2014 07:20:10 -0700

Action Guides
Activity Guides
QRGs - Quick Reference Guides


I wouldn't use 'use cases' but that's just my personal preference.



On Thursday, July 24, 2014 8:32 AM, Lynne Wright <Lynne -dot- Wright -at- tiburoninc -dot- com> wrote:



Integration guides?


-----Original Message-----
From: techwr-l-bounces+lynne -dot- wright=tiburoninc -dot- com -at- lists -dot- techwr-l -dot- com [mailto:techwr-l-bounces+lynne -dot- wright=tiburoninc -dot- com -at- lists -dot- techwr-l -dot- com] On Behalf Of Melanie Albrecht
Sent: July-23-14 9:08 PM
To: TECHWR-L Writing
Subject: What to call a smallish document that describes a particular way to use a product?

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 Lynne -dot- Wright -at- tiburoninc -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


^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
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 klhra -at- yahoo -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

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


References:
What to call a smallish document that describes a particular way to use a product?: From: Melanie Albrecht
RE: What to call a smallish document that describes a particular way to use a product?: From: Lynne Wright

Previous by Author: Re: Code for publishing PDF from Confluence
Next by Author: Re: Can style trump grammar rules?
Previous by Thread: RE: What to call a smallish document that describes a particular way to use a product?
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