[Date Prev][Date Next][Thread Prev][Thread Next][Date Index][Thread Index] [List Home]
[virgo-dev] Eclipse Help and Tooling Documentation

Hi all,

Please see bugs below. We need to create documentation for Virgo tooling, hopefully drawing on other documentation (e.g. WTP) whenever possible. I think it would also be really neat to provide the extensive runtime documentation from within Eclipse as well.

There is already some documentation for the tooling in the existing user docs (chapter 7) but I think we should consider re-organizing it. e.g. give tooling it's own high level Eclipse Docs and making a separate Guide, e.g. "Eclipse IDE Guide" . What do people think? (Alternatively, we could do some sort of docbook magic to break this out for Eclipse Help only but I do think it makes sense as a separate doc.) In general, how closely should I coordinate any such changes with the rest of the Virgo team?

Naturally, w'd like to follow the existing Virgo approach to generating and maintaining documentation. I've used docbook, but based on a toolchain that leverages Mylyn WikiText, i.e. editing the docs in Wikitext, then transforming them to docbook and from there to PDF, web, Eclipse Help, etc.. The Virgo toolchain is a bit different but I should be able to grok it. Is there any documentation of the documentation maintenance process? I can see that I just need to run ant doc to produce the documentation, but I'm not sure what artifacts to actually maintain for the documentation proper. I'm guessing the xml, but there are also .tex artifacts in the design-docs dir.

My thinking is that we should maintain all of the docs including tooling in the documents repository? I'm guessing I already have write access to that, but I might need to make some changes to the docs generation process / dependencies to include Eclipse docs. Does anyone have any problems with that and should I coordinate any such changes here?

cheers,

Miles

376446: Create Eclipse Help for Tooling
https://bugs.eclipse.org/bugs/show_bug.cgi?id=376446
376447: Provide Runtime documentation within Eclipse Help
https://bugs.eclipse.org/bugs/show_bug.cgi?id=376447

______________________________
Miles T. Parker
Senior Engineer and Product Manager, Tasktop
http://tasktop.com
Committer, Eclipse Mylyn and Virgo
Project Lead, Model Focussing Tools and AMP
http://milesparker.blogspot.com
skype: milestravisparker