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:"Janoff, Steven" <Steven -dot- Janoff -at- ga -dot- com> To:"techwr-l -at- lists -dot- techwr-l -dot- com" <techwr-l -at- lists -dot- techwr-l -dot- com>, "Combs, Richard" <richard -dot- combs -at- Polycom -dot- com> Date:Wed, 17 Jul 2013 10:10:13 -0700
Richard, can you expand on your objection to a topic having a single subtopic? I'm trying to understand what you mean by "bad form."
I'm reminded of the idea that a bulleted list shouldn't have a single bullet. Although it doesn't look great, it's sometimes necessary, even when there's enough time for reflection.
Thanks,
Steve
Richard Combs wrote (Wed., July 17, 2013 8:34 AM):
...
The second example would look like this:
1. Alarms overview
A. List of alarms
2. Some other topic
Bad form. A topic shouldn't have a single subtopic. Granted, many of us have occasionally broken that rule when in a hurry, but it's still a good one. I'm a bit surprised that DITA doesn't enforce it.
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
New! Doc-to-Help 2013 features the industry's first HTML5 editor for authoring.
