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:"rebecca officer" <rebecca -dot- officer -at- alliedtelesis -dot- co -dot- nz> To:"Robert Lauriston" <robert -at- lauriston -dot- com>, "TECHWR-L Writing" <techwr-l -at- lists -dot- techwr-l -dot- com> Date:Fri, 25 Jul 2014 17:23:42 +1200
We call documents like that "How To Guides".
>>> Robert Lauriston <robert -at- lauriston -dot- com> 25/07/14 03:46 >>>
That's what I was thinking.
On Thu, Jul 24, 2014 at 6:31 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.
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
Read about how Georgia System Operation Corporation improved teamwork, communication, and efficiency using Doc-To-Help | http://bit.ly/1lRPd2l
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
NOTICE: This message contains privileged and confidential
information intended only for the use of the addressee
named above. If you are not the intended recipient of
this message you are hereby notified that you must not
disseminate, copy or take any action in reliance on it.
If you have received this message in error please
notify Allied Telesis Labs Ltd immediately.
Any views expressed in this message are those of the
individual sender, except where the sender has the
authority to issue and specifically states them to
be the views of Allied Telesis Labs.
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
Read about how Georgia System Operation Corporation improved teamwork, communication, and efficiency using Doc-To-Help | http://bit.ly/1lRPd2l
