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.
That's exactly why I FINALLY recently removed all the section numbering from our manuals.
Providing users with a detailed index as part of a searchable electronic file HOPEFULLY negates the need for clunky, left-margin-eating 4-digit numbering schemes that, to me, just seemed weirdly pedantic and scientificky and not suitable for our target audience/overall corporate image.
I presume, Becca, that in your case you've already determined, in consultation with your colleages, that its really necessary/useful to maintain a numbering system?
-----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 Gene Kim-Eng
Sent: Tuesday, October 16, 2012 1:33 PM
To: Becca
Cc: tech2wr-l
Subject: Re: Numbering paragraphs
In the olden days prior to electronic documents with search functions, the
distinction used to be how important it was going to be to be able to
direct someone to the item or cite it.
Gene Kim-Eng
On Tue, Oct 16, 2012 at 9:02 AM, Becca <becca_price -at- yahoo -dot- com> wrote:
>
> 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?
>
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
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.
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.
