| [rmf-dev] Better RMF documentation |
|
Hi all, I had a talk with Gael (Eclipse Foundation) the other day, and one area where we need improvement is documentation (I am currently trying to raise some funds to co-finance this). But I'd like to start a technical discussion here. I started to look into our current solution (Mylyn/WikiText), and there are a few problems. For one, it's buggy: If you look at the generated Eclipse Help, there are a few pictures missing - I don't know why, but I can reproduce it when regenerating the documentation locally. Also, as cross-references use the text of section names, they are brittle. The main reason to stick with the current solution is that it makes it really easy for anyone to contribute (no Software required, just edit the wiki). Do you know of anything better, or do you have objections to moving away from what we have right now? Several years back, we implemented a solution using Latex and Plastex [1]. That worked well, but I can imagine that Latex scares a lot of contributors. Also, there may be something better around by now. I look forward to your thoughts. Best, - Michael [1] http://handbook.event-b.org/ --
|