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: What do I call this document type? From:Lin Sims <ljsims -dot- ml -at- gmail -dot- com> To:TECHWR-L <techwr-l -at- lists -dot- techwr-l -dot- com> Date:Tue, 26 Nov 2019 16:44:47 -0500
So far, I really like the ideas of Job Aid or How To Use <application
name>, but keep the ideas coming. I'll be running all of them past my
coworker, since we (a) need to agree on the name, and (b) he's the one who
gets to create the banner at the top.
On Tue, Nov 26, 2019 at 4:21 PM Lin Sims <ljsims -dot- ml -at- gmail -dot- com> wrote:
> It's too long for a quick reference (12 pages!), but it isn't a full
> manual.
>
> It covers a subset of features (situations and processes that are unlikely
> to occur are left out), and provides little more than "to do this, perform
> these steps".
>
> There's none of the normal book components, such as a front or back cover
> or a TOC.
>
> I can't call it a reference guide because we use those to provide actual
> reference information such as database field specifications, not how-tos.
>
> I thought about using "<product name> Guide", but to me that implies an
> actual manual.
>
> Suggestions?
>
> --
> Lin Sims
>
--
Lin Sims
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
Visit TechWhirl for the latest on content technology, content strategy and content development | https://techwhirl.com