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.
RE: Arguments for NOT using topics as parents to other topics in DITA-maps
Subject:RE: Arguments for NOT using topics as parents to other topics in DITA-maps From:Steven Jong <stevefjong -at- comcast -dot- net> To:techwr-l -at- lists -dot- techwr-l -dot- com Date:Sat, 20 Jul 2013 13:07:39 -0400
As an old-school writer, I agree that having a single subheading, like having a single-item list, is bad organizational form: if there's only one instance, it doesn't merit being split out. However, as a new-age worker in environment of intensive topic sharing, I find single-item lists and subtopics unavoidable. It has nothing to do with DITA or information architecture, but with topic sharing and products modes.
For example, I document a product that comes in different modes for different kinds of telecom carriers (wireless, cable, fiber-optic). In one mode, you can define a goodly variety of network elements. The information structure is something like this:
Managing Network Elements
About Network Elements
Defining a Network Element
Some Other Element
Editing a Network Element
Deleting a Network Element
In another mode there aren't as many network elements, so the list is shorter. And in one mode, there's only one kind of network element. Logically, if that's the only mode I was documenting, I would have one topic, called "Defining the Network Element." But I am sharing most of the topics, and they are identical across modes. I don't want to have multiple structures to account for the single subtopic in one mode; I would rather break the organizational rule.
The same situation applies to bulleted lists. By retaining the structure and presentation, sometimes (if rarely) we end up with a one-item list.
(For the record, I would most prefer to use structured documentation techniques and have only first-level heads in my document! But the formatting I have to work with is so limited that I've scaled back my ambitions.)
New! Doc-to-Help 2013 features the industry's first HTML5 editor for authoring.