[Author Prev][Author Next][Thread Prev][Thread Next]
[Author Index (this month)][Thread Index (this month)][Top of Archive]

Re: Numbering paragraphs

Subject: Re: Numbering paragraphs
From: "WongWord -at- gmail -dot- com" <wongword -at- gmail -dot- com>
To: "Dan Goldstein" <DGoldstein -at- riveraintech -dot- com>, <techwr-l -at- lists -dot- techwr-l -dot- com>
Date: Wed, 17 Oct 2012 14:06:45 +1100

I hate the 1.2.3.4 numbering. It is so hard to remember. But one possible legitimate argument for it is that frequent users know that the 1, 2 and 3 means a certain topic and that is useful , or so they say.

I did successfully argue against this 1.2.3.4 system in a legal regulator I worked with and I never heard any grumbles from users.

We numbered paras
[acronym for document type ie REP for report, RG for regulatory guide or CP for consultation paper] [the number of the REP, RG or CP with each document given a unique number] [number of para ie 1, 2, 3...]

With this method a cited paragraph reference such as RG 163.145 meant it was Regulatory Guide number 163, para 145. This is an excellent shorthand because it isn't necessary to spell out the type of document nor the content name of RG 163. Everyone knows that no 163 is about xxxx. It is short and sweet.

Two things to remember are:
1 There is a continuing need to cite paragraphs and without para numbering this can't happen. Online now we don't always even have page nos so the ability to exactly cite text is critical. Documents like these without some type of numbering would be like an act of parliament without numbering.

2 Regulations, guides etc are updated. Therefore it is necessary to have policy for adding or subtracting paragraph numbers as text is added and deleted.

Irene Wong
--------------------------------------------------
From: "Robart, Kay" <Kay -dot- Robart -at- tea -dot- state -dot- tx -dot- us>
Sent: Wednesday, October 17, 2012 5:49 AM
To: "Dan Goldstein" <DGoldstein -at- riveraintech -dot- com>; <techwr-l -at- lists -dot- techwr-l -dot- com>
Subject: RE: Numbering paragraphs

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 wongword -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 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 &#8220;Getting Started with Doc-To-Help&#8221; blog post. http://c1.ms/bx

^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^

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

References:
Numbering paragraphs: From: Becca
RE: Numbering paragraphs: From: Dan Goldstein
RE: Numbering paragraphs: From: Robart, Kay

Previous by Author: Restricting Style Formatting in MS Word
Next by Author: Re: passive voice (was RE: Numbering paragraphs
Previous by Thread: RE: Numbering paragraphs
Next by Thread: Re: Numbering paragraphs

[Top of Archive] | [Author Index (this month)] | [Thread Index (this month)]

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

Sponsored Ads