Bug 481327 - The Sirius Starter tutorial should be improved
Summary: The Sirius Starter tutorial should be improved
Status: NEW
Alias: None
Product: Sirius
Classification: Modeling
Component: Documentation (show other bugs)
Version: 3.1.0   Edit
Hardware: All All
: P3 normal (vote)
Target Milestone: ---   Edit
Assignee: Projet Inbox CLA
QA Contact:
URL:
Whiteboard:
Keywords: triaged
Depends on:
Blocks:
 
Reported: 2015-11-03 10:17 EST by Stephane Begaudeau CLA
Modified: 2015-11-06 11:14 EST (History)
1 user (show)

See Also:


Attachments

Note You need to log in before you can comment on or make changes to this bug.
Description Stephane Begaudeau CLA 2015-11-03 10:17:01 EST
https://wiki.eclipse.org/Sirius/Tutorials/StarterTutorial

1- The screenshot used to indicate how to download the Sirius samples if they have not been installed is showing the Sirius 3.0.0 update site URL

https://wiki.eclipse.org/File:Sirius_4mtuto_02-3.png

2- Just after the launch of the new runtime (before the title "Select the Sirius Perspective", a screenshot showing both runtime and indicating that all the remaining steps will be realized in the second runtime would be helpful. But I wonder, since one of the best feature of Sirius is its ability to build a designer in the same workspace as your meta-model, why burden the tutorial with two Eclipse instances?

3- At one point of the tutorial, you are asking users to create a viewpoint specification project but in the screenshot of the wizard, you are reusing an old screenshot so you are asking them to create a project named "basicfamily.sample" while it does already exist in the previous screenshot. On top of that, the screenshot reused shows a modeling project wizard while the users should create a viewpoint specification project.

Before: https://wiki.eclipse.org/File:Sirius_4mtuto_12.png
After: https://wiki.eclipse.org/File:Sirius_4mtuto_05.png

In the screenshot after, we can find out that a new viewpoint specification project named "org.eclipse.sirius.sample.basicfamily.design" should have been created.

A screenshot of the whole workbench with the model explorer view would be helpful.

4- The screenshot showing how to add the metamodel contains a folder named "img" with and image inside, it does not appear anywhere else in the tutorial.

https://wiki.eclipse.org/File:Sirius_4mtuto_25.png

5- The screenshot showing the AQL code completion was not taken at the current step of the tutorial

https://wiki.eclipse.org/File:Sirius_4mtuto_24.png

The result of the content assist displayed in this screenshot are not valid at the step of the tutorial where this screenshot appears since the only semantic candidate expressions is the one from the node ManNode and in this case self refers to the family, so it contains structural features like "name" and "members" but not "children" or "parents".

6- The first screenshot in the section to "Set a Style to the Node" is not very relevant and it does not reflect the current step of the tutorial. I am pretty sure that this image is not the image desired since it appears before (see issue 4).

7- The images given in the tutorial for both the man and the woman could be improved by using svg images instead of small png. The link in the tutorial should also be "https://wiki.eclipse.org/images/4/4a/Png-files.zip" instead of "https://wiki.eclipse.org/File:Png-files.zip". A screenshot of the model explorer view could be added to ensure that the user understand where the images should be placed.
Comment 1 Esteban DUGUEPEROUX CLA 2015-11-06 10:20:21 EST
1. Do you think the screenshot should show the last Sirius update site?
Changing the screenshot at each Sirius release seems time lost for the poor benefit.

2. The use of 3 Eclipse instances is yet the good practise to avoid many issues when developing metamodel, viewpoint specification project and testing them. AQL improve the use of a single workspace but the metamodel plugin must yet be deployed in a first instance.

3. You are right

4. You are right

5. Ok

6. Ok

7. Ok
Comment 2 Stephane Begaudeau CLA 2015-11-06 11:14:33 EST
1- I completely agree with you yet in my experience this week, people see the nice looking image and just copy its content. Maybe trimming / blurring the image to hide the URL but show more clearly where to find the URL to use. Since the image take almost the whole screen, people are just watching it and they are not reading what is written just above.

2- I think that in the tutorial, you just have to manipulate two Eclipse instances (one with the metamodel downloaded and one with the viewpoint specification project but working with both Eclipse was a source of confusion.

Both are not critical issues (duplicated screenshots where more confusing) but these are things that occur when you give this tutorial to 30 newcomers :)