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.
I wouldn't call them justifications, but maybe reasons. IF they are brief,
I'd put each one ahead of the corresponding procedure. I figure if a user
starts with an understanding of why he has to do something, he's more
likely to accept the actions he's supposed to do and just do them, instead
of stopping midway and asking himself what is going on and whether or not
he really should be doing this.
On Tue, Jan 20, 2015 at 1:21 PM, Cardimon, Craig <ccardimon -at- m-s-g -dot- com>
wrote:
> Hello, Whirlers,
>
> I am putting together a Policies & Procedures Manual, which is proceeding
> nicely.
>
> I have been asked to include some justifications, which I will be given,
> for said procedures.
>
> My questions involve *how* to include them:
>
>
> 1. Should I put the justification for the procedure directly after the
> procedure? This is what I'm planning to do right now.
>
> 2. Should I put all justifications in a separate section?
>
> 3. Should I put all justifications in a separate document?
>
> 4. If the justifications go into the same document, should the name of
> the document be changed to Policies, Procedures, & Justifications? I'm
> thinking no.
>
>
>
>
> Cordially,
>
> Craig Cardimon | Senior Technical Writer
> Marketing Systems Group
>
> Information contained in this e-mail transmission is privileged and
> confidential. If you are not the intended recipient of this email, do not
> read, distribute or reproduce this transmission (including any
> attachments). If you have received this e-mail in error, please immediately
> notify the sender by telephone or email reply.
> ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
> Doc-To-Help: The Quickest Way to Author and Publish Online Help, Policy &
> Procedure Guides, eBooks, and more using Microsoft Word |
>http://bit.ly/doctohelp2015
>
> ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
>
> You are currently subscribed to TECHWR-L as bus -dot- write -at- gmail -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
>
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
Doc-To-Help: The Quickest Way to Author and Publish Online Help, Policy & Procedure Guides, eBooks, and more using Microsoft Word | http://bit.ly/doctohelp2015
