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.
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).
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 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 |
> 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
> 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