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: there is vs. there's From:"Combs, Richard" <richard -dot- combs -at- Polycom -dot- com> To:"Zen C" <zenizenc -at- gmail -dot- com> Date:Thu, 17 Apr 2008 10:24:42 -0600
Zen C wrote:
> The SOP doc I am reviewing has an overview of the parent
> company, other partners the company works with, our company
> etc..Does an SOP for a specific department need to have all
> that information?
> My thought is that the employee is provided with other
> manuals to read about the company and why does one have to
> repeat it in a SOP that is for a specific department. I would
> only write about the Department and the tasks.
> Any thoughts on this issue?
My first thought is "What's an SOP?" Standard operating procedure? (And
tangentially related, are employees there really expected to read
_multiple_ manuals about the company? Sounds more like a cult or
movement than a business.)
My second thought is that you're probably right, and it sounds like the
author of this doc was grasping at ways to pad the page count. Of
course, given that there are "other manuals to read about the company,"
padded page counts may be standard operating procedure there. ;-)
My third thought is that you should discuss the scope and content of
this doc with people at your company (such as the people who assigned
you this task, the SMEs for the doc, and the people to whom you'll
Just as there is no global "rule" regarding "there is," there is also no
global "rule" for what belongs in a particular kind of document. Think
"audience" and "purpose" -- then go talk with the people who can help
Richard G. Combs
Senior Technical Writer
richardDOTcombs AT polycomDOTcom
rgcombs AT gmailDOTcom
Create HTML or Microsoft Word content and convert to Help file formats or
printed documentation. Features include support for Windows Vista & 2007
Microsoft Office, team authoring, plus more. http://www.DocToHelp.com/TechwrlList
True single source, conditional content, PDF export, modular help.
Help & Manual is the most powerful authoring tool for technical
documentation. Boost your productivity! http://www.helpandmanual.com
You are currently subscribed to TECHWR-L as archive -at- web -dot- techwr-l -dot- com -dot-