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've been using DITA for several years now, but I'm a captive writer so
I'm not sure what issues might arise in the case you mention. You would
probably get more of a response on a DITA-specific site such as
dita-users (http://tech.groups.yahoo.com/group/dita-users/).
As usual with these things, IT DEPENDS. To be able to help you figure
out the best structure, I'd need to understand your situation a lot
better. I'd be glad to help you offline.
First of all, I wish you a very happy and prosperous year 2010.
Then, I'm posting this message again as the first time I didn't get any
answer. I'm probably unclear in my explanations of the issue I'm facing
but
I find it hard to explain it clearly as I don't have any idea on how to
solve it. Any help would be really appreciated. I'm interested too if
you
have readings to suggest about projects structuring.
I have an issue with the structure of my project. I use DITA, Oxygen to
edit
it, and ClearCase for version control. I output to pdf.
I?m writing the same manual for 2 different clients (but it could be for
more clients). Many topics are common, some are specific and some are of
a
mixed type. I could use metadata to tag the information and then use
DITAVAL
to include or exclude topics; it works well. But how can I do if I need
to
create a manual for a new client and then another new one, and so on?
I figured I could use different folders and follow a structure similar
to
this:
- ManualName
? O Client1
????* Client1 Images
????*(list of files specific to Client1 + Client1 project + Client1
ditamap)
??O Client2
????* Client2 Images
????*(list of files specific to Client2 + Client2 project + Client2
ditamap)
??O Images?????????
??O (list of common files)
Is it feasible (and viable) to work like this? What about mixed type
topics
(topics that are mostly common but the terminology, for instance, is
different)? How can I manage those? With DITAVAL? Variables (using
conref
and not keyref as I'm using DITA 1.1)
Are you looking for one documentation tool that does it all? Author,
build, test, and publish your Help files with just one easy-to-use tool.
Try the latest Doc-To-Help 2009 v3 risk-free for 30-days at: http://www.doctohelp.com/
Explore CAREER options and paths related to Technical Writing,
learn to create SOFTWARE REQUIREMENTS documents, and
get tips on FUNCTIONAL SPECIFICATION best practices. Free at: http://www.ModernAnalyst.com
---
You are currently subscribed to TECHWR-L as archive -at- web -dot- techwr-l -dot- com -dot-