Model-Based System Engineering in Practice: Document Generation – MegaM@Rt Project Experience

SECR 2018
Андрей Садовых
Assistant Professor, Innopolis University

MegaM@Rt2 project is a collaborative initiative of the ECSEL Joint Undertaking under Horizon 2020 EU programme. The project regroups 26 partners from 6 different European countries who jointly address challenges of engineering modern cyber-physical systems by using model-based engineering methods. Since it is a model-based project, we adopted a similar approach for dealing with requirements analysis, architecture, design, roadmap planning and development status checking. In these tasks, document generation methods were particularly useful to create a set of “live” reference specifications and contractual reports. We believe that these methods perfectly demonstrate relevant benefits of the model-based approach and are applicable to many other contexts. Document generation has several challenges, since the produced documents should address several goals and target different audience. Hence, we describe this approach in detail in this paper in the form of an experience report.

In essence, the MegaM@Rt2 project had a rather trivial task to document inception phase of the project. The challenge arises from the scale of the project, we had to deal with hundreds of requirements from completely different users, hundreds of features of 29 tools, which had to be mapped to those requirements in order to analyze a gap and devise a roadmap for a consistent tool chain. With limited resource on technical coordination we had to be extremely efficient and thus we adopted a model-based approach that we describe in this paper. The paper should be helpful to project managers and architects who wish to discuss on model-based approaches from a practical side.

Transcript

1. Model-Based System Engineering in Practice: Document Generation - MegaM@Rt Project Experience Presented by Andrey Sadovykh, Innopolis / Softeam ©Andrey Sadovykh et al. Model-Based System Engineering in Practice: Document Generation - MegaM@Rt Project Experience 1
2. Andrey’s Background  Experience  Project Manager, Coordinator – 14 years  Worked for  SWsoft, AIRBUS, SOFTEAM  Worked with  European Space Agency  Thalès, Scania, Volvo, Nokia, SAP, Bombardier, ATOS, IBM, SIEMENS, EDF MSc MIPT PhD AIRBUS / Sorbonne Uni. MBA HEC Paris  Areas of Interest  Distributed Systems  Model-driven Engineering applied …  Software and services  Cyber-physical systems  Digital Innovation ©Andrey Sadovykh et al. Model-Based System Engineering in Practice: Document Generation - MegaM@Rt Project Experience 2
3. Outline 3  Why documentation?  MegaM@Rt2 project  Documentation for Requirements, Architecture, Roadmap and Traceability  Modelio Demo  Conclusion and discussion  Backup  Requirement Management Approach  Architecture Management Approach Model-Based System Engineering in Practice: Document Generation - MegaM@Rt Project Experience ©Andrey Sadovykh et al.
4. Introduction Model-Based System Engineering in Practice: Document Generation - MegaM@Rt Project Experience ©Andrey Sadovykh et al. 4
5. How much (%) of project time do you spend on documenting? ©Andrey Sadovykh et al. Model-Based System Engineering in Practice: Document Generation - MegaM@Rt Project Experience 5
6. Why documentation? ©Andrey Sadovykh et al. Model-Based System Engineering in Practice: Document Generation - MegaM@Rt Project Experience 6
7. What are the main difficulties in documenting your project? ©Andrey Sadovykh et al. Model-Based System Engineering in Practice: Document Generation - MegaM@Rt Project Experience 7
8. Why documentation? Purpose  Communication  Requirements  Architecture  Design  Test plans  Reviews and reports  Contractual, legal means  Required by process to instill quality Properties  Readers / Stakeholders  Reading style – story or dictionary  Traces and references, diagrams  Formats ©Andrey Sadovykh et al. Model-Based System Engineering in Practice: Document Generation - MegaM@Rt Project Experience 8
9. Problems with the documenting Takes productive time/cost!  Consistency and synchronization  Outdating  Maintaining references  Formatting and presenting  Reusing ©Andrey Sadovykh et al. Model-Based System Engineering in Practice: Document Generation - MegaM@Rt Project Experience 9
10. Model as a blueprint to produce things ©Andrey Sadovykh et al. 10  Models  Descriptive  Prescriptive  Fowler distinguish models as  Sketches – for communication  Blueprints – for development  Programs – for execution  Why modelling in software engineering?  Increase in productivity  Less errors  Cut coding  Drivers  More complex software to be developed including  Increasing need to evolve the software  Lack of software engineering skills  Need to understand the domain problem to support with soft Model-Based System Engineering in Practice: Document Generation - MegaM@Rt Project Experience
11. We can produce documents from models too ©Andrey Sadovykh et al. 11 Requirements • SysML Reqs • UML Use Cases Architecture • UML Components • and Classes • Behavior • Simulations Design • Refined Classes • or Domain Specific Language Implementation • Code generation • Java, C++, Frameworks Mapping, Model transformations and refinements Mapping, Model transformations and refinements Code generation, Automated resource allocation Automated deployment traceability, evolution traceability, reverse traceability Model-Based System Engineering in Practice: Document Generation - MegaM@Rt Project Experience
12. MegaM@Rt2 project and its challenges Model-Based System Engineering in Practice: Document Generation - MegaM@Rt Project Experience ©Andrey Sadovykh et al. 12
13. Scope - MegaM@Rt2 tool box: 13 Model-Based System Engineering in Practice: Document Generation - MegaM@Rt Project Experience ©Andrey Sadovykh et al.  Design time:  Holistic system engineering  Team collaboration over distributed models  Global traceability  Runtime:  Tracing / Monitoring  Models@Runtime
14. Size 14 Model-Based System Engineering in Practice: Document Generation - MegaM@Rt Project Experience ©Andrey Sadovykh et al.
15. Collaboration, Complementarities and Differences 15 Model-Based System Engineering in Practice: Document Generation - MegaM@Rt Project Experience ©Andrey Sadovykh et al.
16. Process 16 Model-Based System Engineering in Practice: Document Generation - MegaM@Rt Project Experience ©Andrey Sadovykh et al.
17. Automating Documentation in MegaM@Rt Requirement, Architecture, Traceability Model-Based System Engineering in Practice: Document Generation - MegaM@Rt Project Experience ©Andrey Sadovykh et al. 17
18. MegaM@Rt2 Approach 18 Model-Based System Engineering in Practice: Document Generation - MegaM@Rt Project Experience ©Andrey Sadovykh et al. Case Study Requirements for Tools Framework Requirements Tools features Wish list for SE tools and methods to be Innovative features in mind for development Collects, synthesizes, traces Traces and monitors
19. MegaM@Rt2 Approach 19 Model-Based System Engineering in Practice: Document Generation - MegaM@Rt Project Experience ©Andrey Sadovykh et al.
20. Individual tools modelling 20  Each conceptual tool set sub-component and relevant interfaces have been refined to better satisfy the refined framework architecture and requirements Model-Based System Engineering in Practice: Document Generation - MegaM@Rt Project Experience ©Andrey Sadovykh et al.
21. Document generation Model-Based System Engineering in Practice: Document Generation - MegaM@Rt Project Experience ©Andrey Sadovykh et al. 21
22. Demo with Modelio Model-Based System Engineering in Practice: Document Generation - MegaM@Rt Project Experience ©Andrey Sadovykh et al. 22
23. Conclusions and discussion Model-Based System Engineering in Practice: Document Generation - MegaM@Rt Project Experience ©Andrey Sadovykh et al. 23
24. Discussion of the MegaM@Rt approach Advantages  Technical coordination support  Requirements traceability  Live architecture document  Single model for everything  Managing integrity of the project  Collaboration support  Common understanding  Common tool  Single reference  Synchronization among WPs  Sharing specification approaches  Sharing document generators  Sharing document structures  Useful tools  Document generation  Document templates  Traceability live view Limitations  Very high-level modelling  Learning curve  Synchronizing contributions  Styling of documents  Still manual effort needed 24 Model-Based System Engineering in Practice: Document Generation - MegaM@Rt Project Experience ©Andrey Sadovykh et al. Conclusions: Overall useful  Can be used in many other similar projects  Uniformity, consistency for many contributors  Approach is implementable in many tools
25. Thank you  Contact info:  andrey.sadovykh@softeam.fr  a.sadovykh@innopolis.ru  Useful links:  https://megamart2-ecsel.eu/  More about tool  http://www.ModelioSoft.com  http://www.modelo.org ©Andrey Sadovykh et al. Model-Based System Engineering in Practice: Document Generation - MegaM@Rt Project Experience 25 Conclusions: Overall useful  Can be used in many other similar projects  Uniformity, consistency for many contributors  Approach is implementable in many tools Future work  Specifying integration means  Specifying tool chains for validation scenarios (eg BPMN)
26. ©Andrey Sadovykh et al. Model-Based System Engineering in Practice: Document Generation - MegaM@Rt Project Experience 26 Backup
27. MMRT Framework Requirements Specification A Top-Down approach  From Case Studies Requirements (a total of 106 CSRs from 9 case study providers )  To MMRT Framework Requirements  Additional input form: initial proposal, SOTA A Bottom-up approach  Tools Components Purposes (28 tools with a total of 223 different TPs)  Realise MMRT Framework Requirements  Framework requirements (FRs) bridge between CSRs and TPs 27 1 Case Study Requirement MMRT Framework Requirement Refine 2 Tool Component Purpose MMRT Framework Requirement Realise Model-Based System Engineering in Practice: Document Generation - MegaM@Rt Project Experience ©Andrey Sadovykh et al.
28. Meet in the Middle 28  Framework requirements (FRs) bridge between CSRs and TPs Purposes  Refinement iterations  Tool support:  Modelio modeling tool to collect CSRs, TPs, create traceability matrices, and generate documentation 2 Tool Component Purpose Realise 1 Case Study Requirement MMRT Framework Requirement Refine Refine Model-Based System Engineering in Practice: Document Generation - MegaM@Rt Project Experience ©Andrey Sadovykh et al.
29. Mapping requirements by traceability matrix 29 Model-Based System Engineering in Practice: Document Generation - MegaM@Rt Project Experience ©Andrey Sadovykh et al.
30. Gap Analysis 30  Looking for:  CSRs coverage  Multiple tools satisfying a requirement: alternative available  Unsatisfied CSR to define mitigation actions (e.g. sharing results from other projects, including additional tools, etc..)  Added values by additional TPs unrelated to CSRs (i.e. suggestion to industrial partners for process improvement) Model-Based System Engineering in Practice: Document Generation - MegaM@Rt Project Experience ©Andrey Sadovykh et al.
31. Gap Analysis Results - Overview 31 #FRs FRs not mapped to any CSRs CSRs not satisfied by any TPs TPs not mapping to any FR WP2 37 3 1 0 WP3 39 4 1 10 WP4 15 0 0 2 Model-Based System Engineering in Practice: Document Generation - MegaM@Rt Project Experience ©Andrey Sadovykh et al.
32. Roadmap Analysis 32  Project management can have a global vision over the tool sets  Tool providers can plan their developments in the project  Case study providers can plan the evaluation of tools ID Baseline (M0) Initial (M15) Intermediate (M20) Final (M32) RTA-00001 MODELIO-150 PAPYRUS-170, MODELIO-130 PAU-020, PAPYRUS- 180, MODELIO-140 RTA-00002 CERTIFYIT-070, CQDESIGN-020, CQDESIGN-110 MBEETLE-010, PAU- 020 RTA-00003 CERTIFYIT-010, RCRS- 010, RCRS-020, RCRS-030, RCRS-040 LIME-010, LIME-020 LIME-030, RCRS- 050, RCRS-080 MBEETLE-010, MODELIO-100, LIME-040, RCRS- 060, RCRS-070 ... ... ... ... ... Model-Based System Engineering in Practice: Document Generation - MegaM@Rt Project Experience ©Andrey Sadovykh et al.
33. Architecture Management Approach Model-Based System Engineering in Practice: Document Generation - MegaM@Rt Project Experience ©Andrey Sadovykh et al. 33
34. Approach for high-level architecture 34  Major element = Tool component  Services  Purposes  Functional interfaces  Subordinate components  Integration means and Deployment  Interfaces / data exchange  Deployment  Relation to the Framework Framework System Engineering Tool Set Traceability and Model Management Tool Set Runtime Tool Set Individual tools Modelio CHESS Collaboro EMFtoCSP Papyrus S3D ……. Realises 4 3 Model-Based System Engineering in Practice: Document Generation - MegaM@Rt Project Experience ©Andrey Sadovykh et al.
35. Framework Modelling 35  MegaM@Rt Framework highlight interfaces to support tools integration and traceability to requirements to guarantee and allow checking model consistency Model-Based System Engineering in Practice: Document Generation - MegaM@Rt Project Experience ©Andrey Sadovykh et al.
36. Individual tools modelling 36  Each conceptual tool set sub-component and relevant interfaces have been refined to better satisfy the refined framework architecture and requirements Model-Based System Engineering in Practice: Document Generation - MegaM@Rt Project Experience ©Andrey Sadovykh et al.
37. ©Andrey Sadovykh et al. Model-Based System Engineering in Practice: Document Generation - MegaM@Rt Project Experience 37 Questions?
38. D1.2 Architecture specification and roadmap - initial version 38  Framework  Conceptual tools as described in the FPP  Individual tools by partners  Properties  High-level requirements help to identify the features, goals and objectives  Functional interfaces and services  Subordinates  Deployment Model-Based System Engineering in Practice: Document Generation - MegaM@Rt Project Experience ©Andrey Sadovykh et al.
39. Specification process Model-Based System Engineering in Practice: Document Generation - MegaM@Rt Project Experience ©Andrey Sadovykh et al. 39
40. Tooling  Modelio  Analyst  Document publisher  Constellation  Collaborative modelling  Configuration management Model-Based System Engineering in Practice: Document Generation - MegaM@Rt Project Experience ©Andrey Sadovykh et al. 40
41. Requirements editing Model-Based System Engineering in Practice: Document Generation - MegaM@Rt Project Experience ©Andrey Sadovykh et al. 41
42. Architecture Model-Based System Engineering in Practice: Document Generation - MegaM@Rt Project Experience ©Andrey Sadovykh et al. 42
43. Traceability Model-Based System Engineering in Practice: Document Generation - MegaM@Rt Project Experience ©Andrey Sadovykh et al. 43
44. Document generation Model-Based System Engineering in Practice: Document Generation - MegaM@Rt Project Experience ©Andrey Sadovykh et al. 44
45. ©Andrey Sadovykh et al. Model-Based System Engineering in Practice: Document Generation - MegaM@Rt Project Experience 45 Additional slides
46. Example: System Development Lifecycle ©Andrey Sadovykh et al. 46 Analysis: • Who are the stakeholders? What is their business? How new system can improve this business? • What is their current system? What system do they need? • Initial design and a prototype Design: •How the system should operate? •Programs? Hardware? Networking? Databases? User Interfaces? Implementation: •Development, Integration, Testing •Deployment •Support Model-Based System Engineering in Practice: Document Generation - MegaM@Rt Project Experience
47. Spiral Model ©Andrey Sadovykh et al. Model-Based System Engineering in Practice: Document Generation - MegaM@Rt Project Experience 47
48. Overall approach 48 Model-Based System Engineering in Practice: Document Generation - MegaM@Rt Project Experience ©Andrey Sadovykh et al.
49. Work packages 49 WP3: MegaM@Rt Runtime Analysis (SMA) 1. Foundations (ABO) 2. Automatic code generation and model execution for runtime (SOFT) 3. Runtime verification and online testing (ABO) 4. Traces analysis (VTT) 5. Case studies support and feedback analysis (SMA) WP4: MegaM@Rt Global Model and Traceability Management (ARM) 1. Foundations (ARM) 2. Scalable model management (ARM) a. megamodelling 3. Scalable model-based techniques (ARM) a. scalable transformations b. iterative verification and validation 4. Traceability / Provenance (UAQ) a. metamodels, formats b. techniques for horizontal and vertical traceability c. continuous development and patterns detect 5. Case studies support and feedback analysis (SOFT) WP2: MegaM@Rt System Engineering (INT) 1. Foundations (UOC) a. standard techniques, paradigms b. collaborative modelling (DSLS, viewpoints, facets) 2. Systems modelling (INT) a. Requirement, b. Functional, c. NFP d. Platform-specific models (Software, Hardware Platform) e. Integration of engineering practices 3. Verification and Validation (UCAN) a. Static analysis b. Simulation 4. Case studies support and feedback analysis (INT) WP1: Case Study Requirements Analysis and Architecture Specification (TEK) 1. Case Study Requirements (TEK) 2. Case Study Definition (TRT) 3. Case Study Baseline Experiments (IKER) 4. Architecture and Roadmap (SOFT) WP5: Integration, Case Study Development and Evaluation (NOK) 1. MegaM@Rt framework integration (ATOS) 2. Case Study Development (NOK) 3. Case Study Evaluation (NOK) WP7: Management WP6: Dissemination and Exploitation Model-Based System Engineering in Practice: Document Generation - MegaM@Rt Project Experience ©Andrey Sadovykh et al.
50. Phases 50 Model-Based System Engineering in Practice: Document Generation - MegaM@Rt Project Experience ©Andrey Sadovykh et al.
51. Process 51 Model-Based System Engineering in Practice: Document Generation - MegaM@Rt Project Experience ©Andrey Sadovykh et al.
52. Next steps for MegaM@Rt modelling approach 52  Matchmaking for Case Studies and Tools  Baseline experiments and refinement of requirements, purposes, roadmap and architecture  Tracing status on features delivery  Planning integration  Case study requirements coverage monitoring Model-Based System Engineering in Practice: Document Generation - MegaM@Rt Project Experience ©Andrey Sadovykh et al.
53. Hackathon session 53  Boost collaboration  Speed-up baseline experiments and prototyping  Base for validation scenarios activities  Early evaluation and results  Feedbacks to design Model-Based System Engineering in Practice: Document Generation - MegaM@Rt Project Experience ©Andrey Sadovykh et al.