Dear all

I already experiemnted some of the Eclipse special support for such feature, here is a short summary of my results : I wanted some kind of tutorial, that would guide my users through complex process. And if possible automate some of the task when possible (open the correct editor, view, at the correct position, etc ..)

I tried the Eclipse Cheat Sheet (http://help.eclipse.org/help32/topic/org.eclipse.platform.doc.isv/guide/ua_cheatsheet.htm) This tools was ok for opening editors (despite the fact that I had to write some dedicated actions) But it appeared to be to simple, complex process doesn't fit very well in it even if you use composite cheat sheet. Another annoying point: you cannot add a lot of documentation directly in the sheet that would explain/tell a story to the user ... Maybe if associated with an eclipse help. But then you have to develop/generate both document in parallel ...

Another more interresting way to achieve that would be to use eclipse commands directly in an help file. (http://help.eclipse.org/help32/topic/org.eclipse.platform.doc.isv/guide/ua_help_content_command.htm) For example, if topcased editors provide such commands, then it would be relatively easy to use then from an help/tutorial file (it uses some javascript to invoke the workbench UI). Probably, there are already some commands in topcased and eclipse that would be really useful for such document.

Regards
Didier

--
Breathe life into your metamodels : www.kermeta.org --
IRISA-INRIA, Campus de Beaulieu, 35042 Rennes cedex, France
Tél: +33 (0) 2 99 84 75 07, Fax: +33 (0) 2 99 84 71 71



[EMAIL PROTECTED] a écrit :

Dear All,

I'd like to submit you a thought concerning the documentation of the model. From my point of view, the model and its associated diagrams enables the user to design and specifies it systems and/or software. so far so good, but generally, when you try to explain to someone (new member of the project, management, customer, certification authorities, ...) you need to add some text and publish documentation to convey the information.

I think it would be of value if Topcased would include a way to edit a document (with titles, basic formatting like bold, italic, understrike, ...) where you can explain your system like a happy story you tell, helping the user to determine a good starting point to understand your system and help him navigate through all views / diagrams. This "additional module" would enable to edit a document that would include hyperlinks to any element and/or diagram of the model (to avoid inconsistency between what you have and what you tell), with the possibility to determine case by case which kind of information you want to display (for example, you might want to see only the requirement with their id and text, but not their verification mean if the audience of your document don't care about that).

What do you think of that ?

best regards

gabriel


Gabriel SCOLAN
--------------------------------------------------------------------------------------------
Messier-Bugatti - DY/TSP
(+33) 1 46 29 28 09
Zone Aéronautique Louis Breguet - BP 40 - F-78141 Vélizy-Villacoublay
[EMAIL PROTECTED]
--------------------------------------------------------------------------------------------

**********************************************************************

"Ce courriel et les documents qui sont attachés peuvent contenir des

informations confidentielles. Si vous n'êtes pas le destinataire escompté,

merci d'en informer l'expéditeur immédiatement et de détruire ce courriel

ainsi que tous les documents attachés de votre système informatique. Toute

divulgation, distribution ou copie du présent courriel et des documents attachés

sans autorisation préalable de son émetteur est interdite."

"This e-mail and any attached documents may contain confidential or proprietary

information. If you are not the intended recipient, please advise the sender immediately

and delete this e-mai land all attached documents from your computer system. Any

unauthorised disclosure, distribution or copying hereof is prohibited."

**********************************************************************

------------------------------------------------------------------------

_______________________________________________
Topcased-users mailing list
[email protected]
http://lists.gforge.enseeiht.fr/mailman/listinfo/topcased-users


_______________________________________________
Topcased-users mailing list
[email protected]
http://lists.gforge.enseeiht.fr/mailman/listinfo/topcased-users

Reply via email to