RE: Numbering paragraphs

Subject: RE: Numbering paragraphs
From: "Robart, Kay" <Kay -dot- Robart -at- tea -dot- state -dot- tx -dot- us>
To: "Dan Goldstein" <DGoldstein -at- riveraintech -dot- com>, <techwr-l -at- lists -dot- techwr-l -dot- com>
Date: Tue, 16 Oct 2012 13:49:31 -0500

If that's the case, then this approach seems incredibly old-fashioned.

-----Original Message-----
From: techwr-l-bounces+kay -dot- robart=tea -dot- state -dot- tx -dot- us -at- lists -dot- techwr-l -dot- com [mailto:techwr-l-bounces+kay -dot- robart=tea -dot- state -dot- tx -dot- us -at- lists -dot- techwr-l -dot- com] On Behalf Of Dan Goldstein
Sent: Tuesday, October 16, 2012 11:23 AM
To: techwr-l -at- lists -dot- techwr-l -dot- com
Subject: RE: Numbering paragraphs

There is NO regulatory requirement from FDA for numbering and bulleting.


-----Original Message-----
From: Becca
Sent: Tuesday, October 16, 2012 12:03 PM
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.




This message contains confidential information intended only for the use of the addressee(s). If you are not the addressee, or the person responsible for delivering it to the addressee, you are hereby notified that reading, disseminating, distributing, copying, electronic storing or the taking of any action in reliance on the contents of this message is strictly prohibited. If you have received this message by mistake, please notify us, by replying to the sender, and delete the original message immediately thereafter. Thank you.


^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
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 kay -dot- robart -at- tea -dot- state -dot- tx -dot- us -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

^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
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 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


Follow-Ups:

References:
Numbering paragraphs: From: Becca
RE: Numbering paragraphs: From: Dan Goldstein

Previous by Author: Re: Another way to say High-Performance
Next by Author: RE: Editing PDFs
Previous by Thread: Re: Numbering paragraphs
Next by Thread: Re: Numbering paragraphs


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

Sponsored Ads


Sponsored Ads