Numbering paragraphs

Subject: Numbering paragraphs
From: Becca <becca_price -at- yahoo -dot- com>
To: tech2wr-l <techwr-l -at- lists -dot- techwr-l -dot- com>
Date: Tue, 16 Oct 2012 09:02:45 -0700 (PDT)

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

Previous by Author: Al Geist wants to share a shopping list with you
Next by Author: Re: Numbering paragraphs
Previous by Thread: Re: Language guide for writing specifications
Next by Thread: RE: Numbering paragraphs


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

Sponsored Ads


Sponsored Ads