Bug 518019 - Refresh the screenshots appearing in the documentation
Summary: Refresh the screenshots appearing in the documentation
Status: NEW
Alias: None
Product: Sirius
Classification: Modeling
Component: Documentation (show other bugs)
Version: 5.0.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: 2017-06-08 12:49 EDT by Pierre-Charles David CLA
Modified: 2017-06-12 08:40 EDT (History)
0 users

See Also:


Attachments

Note You need to log in before you can comment on or make changes to this bug.
Description Pierre-Charles David CLA 2017-06-08 12:49:42 EDT
The current documentation includes many screenshots taken from previous versions of Sirius which do not match the current UI, and/or the currently recommended practices (for example there are still expressions written using the legacy query language deprecated years ago in the sequence diagrams specifier doc).

We should refresh them to:
* reflect the current state of the UI;
* be more consistent (all should be taken from the same environment, preferably a Windows 10 machine);
* use the new package::Class syntax for all domainClass examples;
* use AQL (and possibly var:/service:/feature:) for all interpreted expressions;
* maybe other changes I'm missing for now.

While doing this we should keep all the examples (VSMs, projects etc.) used for illustration so that it is easier to perform similar refresh for later versions if we ever drift again too much, or more simply to have ready-to-use examples when documenting adding screenshots for new features. As much as possible, existing modelers (e.g. the "basic family" tutorial solutions) should be used.

Ideally, RCPTT scripts could be developed to automate the creation of screenshots for whole parts of the documentation. I'm not sur how realistic that is, but we should at least give it a try.