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.
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:Lynne Wright <Lynne -dot- Wright -at- tiburoninc -dot- com> To: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 13:31:55 +0000
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?
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
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."
Read about how Georgia System Operation Corporation improved teamwork, communication, and efficiency using Doc-To-Help | http://bit.ly/1lRPd2l