Re: Policies & Procedures Manual questions

Subject: Re: Policies & Procedures Manual questions
From: Debra Kahn <kahndebra -at- gmail -dot- com>
To: Mike Starr <mike -at- writestarr -dot- com>
Date: Tue, 20 Jan 2015 13:43:26 -0700

If by justification you mean a statement of the end objective of the
procedure, then that is part of the purpose statement for the procedure -
as Robert and Mike have said. In each of the procedure documents that I am
writing for my current gig, we have a purpose section. Verbiage in that
section can be as elaborate as necessary (depending on the procedure), but
typically is about 2-4 sentences.

If by justification you mean industry standards, you could cite those in a
'references' section of the procedure document. (For example, "ASTM-D523,
Standard Test Method for Specular Gloss")

If by justification, you mean data collected internally, that is a
different animal. If the data is collected into a single report somewhere,
you could perhaps cite the report in a 'related documents' section of the
procedure document. But, honestly, that kind of justification should have
been done as part of change management - a sort of rally the troops effort
- before the decision was made to document the procedure. Publishing a
document shouldn't be a substitute for managing change well (my opinion).

Deb K

*Debra Kahn**, MA, PMP, CA-AM*
debra -at- dk-consulting -dot- co *or *kahndebra -at- gmail -dot- com
Business: 970-541-0888
http://dk-consulting.co
Twitter: @dkconsultco

On Tue, Jan 20, 2015 at 1:15 PM, Mike Starr <mike -at- writestarr -dot- com> wrote:

> I think Robert's got it right... it doesn't need a subheading or a
> separate document. Just put it right in the initial paragraph before the
> actual procedure.
>
> Best Regards,
>
> Mike
> --
> Mike Starr, Writer
> Technical Writer - Online Help Developer - WordPress Websites
> Graphic Designer - Desktop Publisher - Custom Microsoft Word templates
> (262) 694-1028 - mike -at- writestarr -dot- com - http://www.writestarr.com
> President - Working Writers of Wisconsin http://www.workingwriters.org/
>
> On 1/20/2015 1:48 PM, Robert Lauriston wrote:
>
>> I'd call it Policies & Procedures. I would not use the word justification.
>>
>> I'd make the goal part of the topic sentence of the policy. "A well
>> regulated militia being necessary to the security of a free state, the
>> right of the people to keep and bear arms shall not be infringed."
>>
> ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
> 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 kahndebra -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

^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^

You are currently subscribed to TECHWR-L as archive -at- web -dot- techwr-l -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


References:
Policies & Procedures Manual questions: From: Cardimon, Craig
Re: Policies & Procedures Manual questions: From: Robert Lauriston
Re: Policies & Procedures Manual questions: From: Mike Starr

Previous by Author: Re: Any experience with AIIM?
Next by Author: Re: Upload versus download
Previous by Thread: Re: Policies & Procedures Manual questions
Next by Thread: Re: Policies & Procedures Manual questions


What this post helpful? Share it with friends and colleagues:


Sponsored Ads