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.
Subject:Re: Eclipse for doc releases? From:Anindita Basu <anindita -dot- basu -at- in -dot- ibm -dot- com> To:techwr-l -at- lists -dot- techwr-l -dot- com Date:Thu, 18 Jun 2009 19:04:14 +0530
<Peter Crimmin wrote> Looking for ideas and pointers.
Does anyone on the list use Eclipse to deliver documentation?
I'm not asking about documenting an Eclipse plug-in. I want to learn
about using Eclipse solely to provide documentation. I haven't (yet)
found a description of how this is done, but I assume it involves:
1. Packaging an Eclipse JRE for installation on the customer's machine.
2. Installing documentation as a plug-in.
Using this approach, I expect to install several plug-ins (from
different products that I release) into a single documentation system.
Thanks in advance. </Peter Crimmin wrote>
Yes, we use Eclipse to deliver our docs. Even for non-Eclipse products.
If your product is not based on Eclipse, you can distribute your docs in
the stand-alone mode (where your docs are packaged with your product and
get installed on the customer's machine) or through an infocenter (where
your Eclipse JRE is hosted on your server and available through the Web).
You can add as many plug-ins as you want to your infocenter - which means a
single infocenter can contain all the docs from the several products that
you release.
Free Software Documentation Project Web Cast: Covers developing Table of
Contents, Context IDs, and Index, as well as Doc-To-Help
2009 tips, tricks, and best practices. http://www.doctohelp.com/SuperPages/Webcasts/
Help & Manual 5: The complete help authoring tool for individual
authors and teams. Professional power, intuitive interface. Write
once, publish to 8 formats. Multi-user authoring and version control! http://www.helpandmanual.com/
---
You are currently subscribed to TECHWR-L as archive -at- web -dot- techwr-l -dot- com -dot-