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:"Rick Quatro" <rick -at- rickquatro -dot- com> To:"'Lin Sims'" <ljsims -dot- ml -at- gmail -dot- com>, "'TECHWR-L'" <techwr-l -at- lists -dot- techwr-l -dot- com> Date:Tue, 26 Nov 2019 16:28:46 -0500
I think Quick Reference is appropriate if it is a subset of a larger manual.
Or maybe Common Procedures.
Rick Quatro
Carmen Publishing Inc.
rick -at- frameexpert -dot- com
585-729-6746
www.frameexpert.com/store/
-----Original Message-----
From: techwr-l-bounces+rick=rickquatro -dot- com -at- lists -dot- techwr-l -dot- com
<techwr-l-bounces+rick=rickquatro -dot- com -at- lists -dot- techwr-l -dot- com> On Behalf Of Lin
Sims
Sent: Tuesday, November 26, 2019 4:21 PM
To: TECHWR-L <techwr-l -at- lists -dot- techwr-l -dot- com>
Subject: What do I call this document type?
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
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
Visit TechWhirl for the latest on content technology, content strategy and
content development | https://techwhirl.com
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
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
Visit TechWhirl for the latest on content technology, content strategy and content development | https://techwhirl.com