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 have written manuals that do number every paragraph, however, this style
is only used when defining a step or next procedure. As it allows a company
to tell its customer, "Please see step 5.1.2.7," for a specific or detailed
instruction. This style can be quite useful and very organized if applied
correctly.
I would think it would rather obvious when to use a bulleted list instead.
Honestly though, I believe it depends on the type of instruction you are
giving. If the company doesn't have a set style or a template that is
written in stone, I would suggest developing a standard that best explains
the information. Though keep in mind to consult with the company, subject
matter experts and even consider the expectations of the end-user.
On Tue, Oct 16, 2012 at 10:13 AM, Lynne Wright
<Lynne -dot- Wright -at- tiburoninc -dot- com>wrote:
> I can't imagine having to work in situation where you've got to number
> paragraphs... sounds like an invitation to cluttery chaos to me, BUT:
>
> Logically, I would think that you'd apply the same logic to para numbering
> as you would to creating sections. Ie. if there are several paragraphs that
> are explaining one concept, you'd group them under one number.
>
> Use bullets for lists (not numbers! partially because there's already
> enough numbering going on, but also because numbered lists can indicate a
> series steps within a procedure) of items within a paragraph.
>
> -----Original Message-----
> From: techwr-l-bounces+lynne -dot- wright=tiburoninc -dot- com -at- lists -dot- techwr-l -dot- com[mailto:
> techwr-l-bounces+lynne -dot- wright=tiburoninc -dot- com -at- lists -dot- techwr-l -dot- com] On
> Behalf Of Becca
> Sent: Tuesday, October 16, 2012 1:09 PM
> To: tech2wr-l
> Subject: Re: Numbering paragraphs
>
> That may be. Is there any standard system for numbering paragraphs,
> though? How do you know when to number a paragraph and when not to? or is
> it a case of number them all, and God will know his own?
>
>
> Regards,
>
>
> Becca
>
>
> >________________________________
> >From: Dan Goldstein <DGoldstein -at- riveraintech -dot- com>
> >To: techwr-l -at- lists -dot- techwr-l -dot- com
> >Sent: Tuesday, October 16, 2012 12:22 PM
> >Subject: RE: Numbering paragraphs
> >
> >There is NO regulatory requirement from FDA for numbering and bulleting.
> >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 Lynne -dot- Wright -at- tiburoninc -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
>
> ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
> 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 ncavier -at- deanhouston -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 electronic mail message contains information which is (a) LEGALLY
PRIVILEGED, PROPRIETARY IN NATURE, OR OTHERWISE PROTECTED BY LAW FROM
DISCLOSURE, and/or (b) intended only for the use of the Addressee(s) named
herein. If you are not the Addressee(s), or person responsible for
delivering this to the Addressee(s), you are hereby notified that reading,
copying, or distributing this message is prohibited. If you have received
this electronic mail message in error, please contact the mail Sender(s) by
replying to this electronic mail message and take the steps necessary to
delete the message from your computer.
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
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.
