Skip to main content
Participant
June 13, 2013
Question

Do I need a seperate XML editor to edit FrameMaker DITA generated files?

  • June 13, 2013
  • 1 reply
  • 1262 views

I am familiar with FrameMaker. However, I have never used structured FrameMaker or DITA. I am just starting a new project and need to make recommendations.

This topic has been closed for replies.

1 reply

Inspiring
June 13, 2013

That depends on the version you are using and what you are going to do with those DITA documents. But generally an improved text editor with syntax encoding is always a good asset. For creating DITA with FM, you don't need an extra XML editor, but for troubleshooting, getting a glance at the true and unchanged XML file and other debugging, tools like notepad++, textpad and so on are what you really want.

One more hint about DITA: get to know DITA from the inside out, before you advise for or against it and don't do anything, you'd be sorry about lateron

Cheers

Alex

6WATTSAuthor
Participant
June 14, 2013

Can you please expand on your last comment - we are at an early stage. We are not converting any unstructured documents. We are actually starting anew with structured documents and DITA. Are there some unforeseen pitfalls of which I need to be aware?

Inspiring
June 14, 2013

The thing is, DITA doesn't fit for everybody. To have a successful DITA workflow, you'll need full approval of your authors. If they don't like DITA and don't support it, you are going to end up with lots of costs while building the workflow and even more costs cleaning up the mess they caused after you change to some other structure.

DITA is still foremost very good at one thing: software documentation. If you do anything else, you will most likely end up using some other XML environment (yes, I know DITA specialisations and DITA 1.2 change that a bit, but still).

The best you can do, is to sit down and try to figure out what structure fits best to your documentation needs. Analyse your documents and see, if DITA fits to it. Estimate how much work a specialization would be. If there's too many changes you would need to make, you're most likely better off using a custom structure.

You need to check all angles of implementing a structure, from building up knowledge, training your writers, writing and _maintaining_ the structure and adaptions, acceptance by your writers and so on.

If after all evaluation still DITA stands on your paper, go for it. If something else is written down there, go for that.

Our company ventured too into the wilds of DITA, but we had to leave those wilds for good to keep in business. And I'm still trying to clean up the mess, that venture caused.

tldr;

I'm not voting against DITA here. What I'm voting for, is a well planned move towards structured authoring. Don't get hasty, don't run after the fancy car they're trying to sell you, keep a rational view on things and especially keep your eye on the acceptance of your writers.

There's nothing more messy, than to clean up after a half-assed try to implement something unsuitable or unwanted.