Re: Guidelines for Eclipse Help

Subject: Re: Guidelines for Eclipse Help
From: Martha J Davidson <editrix -at- nemasys -dot- com>
To: "TECHWR-L" <techwr-l -at- lists -dot- techwr-l -dot- com>
Date: Thu, 28 Apr 2005 15:17:59 -0700


At 11:43 PM 4/27/2005, Iliana Kostova wrote:

Currently, I am developing online help for our Eclipse plugins and I am looking for some templates, layout guidelines (CSS and standard images) and information on the conventional types of guides ("Getting Started", "Concepts", etc.) that an Eclipse documentation set usually has. I've found some information on the HP developer zone, but I couldn't discover anything on eclipse.org.

Quite a few of us are creating help for Eclipse plugins these days. You'll probably get better answers to your questions if you ask on the Eclipse_tw group on yahoo, which was created as a place to share ideas about Eclipse help: http://groups.yahoo.com/group/eclipse_tw/

I'm single-sourcing a full doc set from FrameMaker source using WebWorks to create help that's fully compliant with the Eclipse help format. I didn't change the structure of my docs when we went from JavaHelp to Eclipse for our online help. I still have a Tutorial, User Guide, Patterns Guide, Installation Guide, and Reference information that supports the tool I document (for automated generation and execution of unit tests for Java code).

I'm sure other folks on Eclipse_tw will have more ideas for you.

martha

--
Martha Jane {Kolman | Davidson}
Dances With Words
editrix -at- nemasys -dot- com

"Too many words bring about exhaustion."
--Tao Te Ching, Chapter 5 (translated by Sheets/Tovey)



^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^

WEBWORKS FINALDRAFT - EDIT AND REVIEW, REDEFINED
Accelerate the document lifecycle with full online discussions and unique feedback-management capabilities. Unlimited, efficient reviews for Word
and FrameMaker authors. Live, online demo:
http://www.webworks.com/techwr-l

---
You are currently subscribed to techwr-l as:
archiver -at- techwr-l -dot- com
To unsubscribe send a blank email to leave-techwr-l-obscured -at- lists -dot- techwr-l -dot- com
Send administrative questions to lisa -at- techwr-l -dot- com -dot- Visit
http://www.techwr-l.com/techwhirl/ for more resources and info.



Previous by Author: Re: resume fondling -- am I being too picky?
Next by Author: Re: What notebook did you buy?
Previous by Thread: Guidelines for Eclipse Help
Next by Thread: # of writers to developers


What this post helpful? Share it with friends and colleagues:

Sponsored Ads


Sponsored Ads