D6.4.1 Ergonomics Guidelines document for the Writer Part

[ferhaterata]

This is an issue of the task T6.4 User Interfaces Implementation (OBEO + SOGETI + UNIT + KOCSISTEM)

This task is about providing all the graphical user interfaces allowing the user to interact with the Knowledge Base content, and fix synchronization issues between documentation and models. For the Writer part: o To help preventing errors of ergonomics (based on lessons from past development of TopiWriter), ergonomics guidelines will have to be defined for the Writer part. The result of this work will be captured under an Ergonomics Guidelines document (D6.4.1). o Definition of the evaluation procedures for Task T6.8 (based on deliverables from WP1). o Implementation of the User Interfaces (D6.4.2-x) allowing the user to use all the features provided by the Knowledge Base (see WP4):

• Fix the consistency issues detected by the Model Checker (T4.4)
• Compare the current version of the document with a previous one thanks to the Semantic Comparison engine (T4.6) For the Bi-directional synchronisation capabilities of the Knowledge Base (see T4.9): an implementation of all UI parts integrated to the Eclipse platform, allowing the user to update models or documentation directly inside his IDE (D6.4.3-x). The following features are considered as the minimal sets of UI parts required for ModelWriter Use Cases: o Provide actions (quick-fixes) allowing the user to fix synchronization issues, whether by updating the models or the documentation o Provide UI mechanism (such as quick-outlines and hyperlink detectors) to navigate easily from model elements to the related documentation parts o Provide views (existing views like the Eclipse "Problem" view may be populated) allowing to get all the synchronization issues between documentation and models o Provide views allowing the user to determine which model elements have not yet been documented o Provide views allowing to get all the differences between models as defined in the documentation and models actually used by the development team The implementation of these UI Parts will be contributed to the open-source Intent project. Additional UI features, such as integration bridges with existing modelling tools (e.g. standard EMF tooling or Obeo Designer) allowing to see synchronization issues directly inside modellers may be provided, if the Use Cases analysis prove that this is a must-have feature. The implementation of these UI Parts will be contributed to the open-source Intent project.

[mrostren]

email sent to ModelWriter consortium on 18th of May:

In order to complete the D6.4.1 guidlines please find attached the first draft which initiates the document. I invite all partners to review, complete and comment this document during the work in progress. Please open track change utility before making your changes.

Since Unit is leading the T6.3 and has already a little idea about how integrating word-processor to eclipse (basing on information given by Ferhat and Moharram during Brussels Workshop), I Invite Ferhat and Moharram to send a first version of the document containing a description of their expected writer part before completing on our side with the interactions with the knowledge base,

We attempt to have screenshots, for that I recommend to use wireframesketcher. If you need more information please refer to wireframesketcher.com

---

[m-challenger]

• UNIT will insert some screenshots in the document.
• OBEO will finalize the document and close the issue.

[ylussaud]

seems good to me. I'm closing the issue.