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: automating Frame doc updates via external code ? (was: in search for better tools)
Subject:Re: automating Frame doc updates via external code ? (was: in search for better tools) From:Robert Lauriston <robert -at- lauriston -dot- com> To:techwr-l -at- lists -dot- techwr-l -dot- com Date:Tue, 8 Dec 2009 14:10:32 -0800
In Frame, the process was the usual for importing variables. The
programmers wrote a script that exported the API elements in .mif
format. These days, I suppose you'd probably use XML instead, so you
wouldn't have to do the work over if you switched from Frame.
You could definitely use that in combination with javadoc or Doxygen
or whatever to keep a FrameMaker book in sync.
On Tue, Dec 8, 2009 at 2:03 PM, Monique Semp <monique -dot- semp -at- earthlink -dot- net> wrote:
> Hi Robert,
>
> Could you elaborate on what process was used to automate FrameMaker doc
> updates based on source code? I'd be very curious as to the tools and
> work-flow.
>
> I do lots of API documentation, and I've (almost) always worked directly in
> the source code and used tools such as Javadoc and Doxygen/DoxyS. And the
> big argument I've always made is that it was impossible to keep an external
> (FrameMaker or Word) doc in synch with changing code. So it looks like
> I've missed a possibility!
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
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/
Help & Manual 5: The all-in-one help authoring tool. True single- sourcing --
generate 8 different formats and as many different versions as you need
from just one project. Fast and intuitive. http://www.helpandmanual.com/
---
You are currently subscribed to TECHWR-L as archive -at- web -dot- techwr-l -dot- com -dot-
