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.
Use if xrefs in topic based or minimalist writing; was, RE: an editing question
Subject:Use if xrefs in topic based or minimalist writing; was, RE: an editing question From:"Porrello, Leonard" <lporrello -at- illumina -dot- com> To:Monique Semp <monique -dot- semp -at- earthlink -dot- net>, Becca <becca -at- di -dot- org>, tech2wr-l <techwr-l -at- lists -dot- techwr-l -dot- com> Date:Mon, 17 Jun 2013 19:21:57 +0000
Are you eliminating all xrefs?
-----Original Message-----
From: techwr-l-bounces+lporrello=illumina -dot- com -at- lists -dot- techwr-l -dot- com [mailto:techwr-l-bounces+lporrello=illumina -dot- com -at- lists -dot- techwr-l -dot- com] On Behalf Of Monique Semp
Sent: Monday, June 17, 2013 11:57 AM
To: Becca; tech2wr-l
Subject: Re: an editing question
> In cases like this, is it common to get the chapters helter-skelter
> and out of order? I'm finding it very difficult to edit the chapters
> out of context.
Yes, it's very common; such is the life of tech writers and editors. And for Agile environments, not only do you receive things out of order, you have to write them out of order as the software crawls to completion. Plus, in extreme minimalism and/or topic-based authoring environments, every topic is supposed to stand on its own, with no expectation that anyone is going to read anything "in order". (I'm still trying to break my habit of including xrefs everywhere.)
YMMV,
-Monique
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
New! Doc-to-Help 2013 features the industry's first HTML5 editor for authoring.
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
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
New! Doc-to-Help 2013 features the industry's first HTML5 editor for authoring.