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'm a lowly contractor. My job wasn't to develop the template for the procedures and work instructions, only to develop a style guide to help other people who are developing the actual procedures and work instructions, and for me to use for some sort of stylistic consistency. I'm inherited the numbering system; I'm just trying to suss out the rationale for when things are numbered and when they're not, so everyone will do it the same way.
I do think that the numbered and indented paragraphs aren't the best way to do things... but then, what people are writing and calling procedures aren't what I would call a procedure... there's very little "do this... do this next step" in them. Most of them are written passive voice (and I'm getting a lot of push-back when I try to write them in active).
I'm doing the best with what I've been given, but I have very little (read,none) influence over the finished projects.
Â
Regards,
Becca
>________________________________
> From: Ben Davies <bdavies -at- imris -dot- com>
>To: Becca <becca -at- di -dot- org>; tech2wr-l <techwr-l -at- lists -dot- techwr-l -dot- com>
>Sent: Thursday, October 18, 2012 5:47 PM
>Subject: RE: Numbering paragraphs
>
>I would question your Quality / Regulatory department to see if numbered paragraphs are truly a regulatory requirement, or if they are simply something someone implemented a long time ago as a way to refer to individual paragraphs easily (but isn't actually a true regulatory requirement).
>
>I work for a medical device company. We submit documentation to FDA for approval all the time. I just finished developing company templates.
>
>We do not use any numbered paragraphs.
>
>Our technical manuals use numbered headings.
>Our operator manuals do not use numbered headings.Â
>
>FDA seems fine with what we are doing...
>
>
>
>-----Original Message-----
>From: techwr-l-bounces+bdavies=imris -dot- com -at- lists -dot- techwr-l -dot- com [mailto:techwr-l-bounces+bdavies=imris -dot- com -at- lists -dot- techwr-l -dot- com] On Behalf Of Becca
>Sent: October-16-12 11:03 AM
>To: tech2wr-l
>Subject: Numbering paragraphs
>
>At my current job, in the documents we create, all paragraphs are numbered. I think this is a regulatory issue - we develop medical devices, and everything is under strict FDA rules.
>Â
>I'm currently creating templates and developing procedures for writing procedures. I've never worked in this kind of environment before, so I'm trying to develop guidelines for when things need to be numbered, and when a simple bullet list will do, for example.
>Â
>What I currently have is the following:
>Â
>Â
>1.1 Numbering Paragraphs
>1.1.1.ÂÂÂÂ Number paragraphs and sub paragraphs.
>1.1.2.ÂÂÂÂ If a list under a numbered paragraph is to be considered part of that paragraph, use bullets. If the list under a numbered paragraph consists of items that can stand alone, number the paragraph as a sub-number to the original paragraph, See section 5.3.1 of this document for an example of when to number a list. See section 5.3.1.9 of this document for an example of when to use bullets.
>
>Does this sound reasonable? or should what would ordinarily be a bullet point be numbered with the next sub-level of heading?
>
>As another example, if I'm listing the items that should be in the document header, should those items beÂbullets orÂnumbered?
>
>Thanks for any guidance you can give me.
>
>
>Becca
>
>^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
>Create and publish documentation through multiple channels with Doc-To-Help. Choose your authoring formats and get any output you may need.
>
>Try Doc-To-Help, now with MS SharePoint integration, free for 30-days.
>
>http://bit.ly/doc-to-help
>
>^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
>
>You are currently subscribed to TECHWR-L as bdavies -at- imris -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
>
>_______________________________________________
>This email has been scanned by the IMRIS Email Security System.
>
>This email has been scanned by the IMRIS Email Security System
>^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
>Writer Tip: You have more time to author content with Doc-To-Help, because your project can be up and running in 3 steps.
>
>See the âGetting Started with Doc-To-Helpâ blog post. http://bit.ly/doc-to-help-3-steps
>^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
>
>You are currently subscribed to TECHWR-L as becca_price -at- yahoo -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
>
>
>
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
Writer Tip: You have more time to author content with Doc-To-Help, because your project can be up and running in 3 steps.
See the “Getting Started with Doc-To-Help” blog post. http://bit.ly/doc-to-help-3-steps
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
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
