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:Chris Despopoulos <despopoulos_chriss -at- yahoo -dot- com> To:techwr-l -at- lists -dot- techwr-l -dot- com Date:Thu, 18 Jun 2009 04:35:15 -0700 (PDT)
I actually looked into this a few years ago. In our case, it was appropriate to have a server-based doc delivery since the product was server based, and different users could have access to different components. The problems of load time for the doc system were NA because the doc server started up with the product.
I looked at this a few releases ago (pre-Europa), and Eclipse changed its architecture somewhat. The last time I looked I never found an obvious separation of the doc server, and since the idea was abandoned by those above, I quit looking. The old doc subset was very small, and based on Tomcat... Not sure what's up with Europa and Ganymeade.
I thought this was an excellent way to go. You can install and serve the docs from the user's desktop (make the server a service so it loads as the machine starts up), from a server on the LAN, from a VM appliance, or from a server on the WAN. It gives you all the usual goodies (search, TOC, etc.) and a great update mechanism. Plus you have hooks to implement role-based access to doc sets.
Frankly, I believe that in the not-too-distant future we'll all use servers they way we currently use desktop apps. Look at the JEdit text editor for an example of a tiny server that manages what is usually a desktop process. (Overkill? Perhaps, but it's still interesting.) Using Eclipse to deliver docs may indeed be appropriate for you, and a good idea. I hope you keep the list posted on your progress.
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-