[jboss-jira] [JBoss JIRA] (DROOLS-3659) DMN: UX for documentation reports

[Tiago Dolphine (Jira)]

    [ https://issues.jboss.org/browse/DROOLS-3659?page=com.atlassian.jira.plugin.system.issuetabpanels:comment-tabpanel&focusedCommentId=13702522#comment-13702522 ] 

Tiago Dolphine commented on DROOLS-3659:
----------------------------------------

Hi [~manstis] about downloading the documentation, the way it was decided to be quicker and work on the same way as the jbpm-designer is to have a printable version of the documentation, see the button on the top right, and use the browser to save as a pdf (now this is coupled to the bpmn documentation view page, but it could be extracted to some common component.
About the documentation generation, yeah it is based on a given text template (we are using https://mustache.github.io/ engine and the syntax that is pretty simple to use) and a data model that should be generated based on the diagram/graph structure, so it is flexible to generate all that is necessary for DMN documentation requirements.

> DMN: UX for documentation reports
> ---------------------------------
>
>                 Key: DROOLS-3659
>                 URL: https://issues.jboss.org/browse/DROOLS-3659
>             Project: Drools
>          Issue Type: Story
>          Components: DMN Editor
>            Reporter: Liz Clayton
>            Assignee: Liz Clayton
>            Priority: Major
>              Labels: UX, UXTeam, drools-tools
>         Attachments: DROOLS-3659-documentation.mp4
>
>
> User stories:
> * As a user I want to generate a PDF or HTML report of the DMN model, with documentation, so that I can hand it off to external team and/or business that needs information about the diagrams and the logic of the decisions being automated. The report can be printed out and used by business teams not involved with the modeling itself, to learn about content of the .dmn file. 
> * As a user I need a means through the UI to input additional documentation, links and attachments to nodes.
> Notes:
> - Docs to help with docs formatting.
> - Might be able to leverage Case View docs widget. 



--
This message was sent by Atlassian Jira
(v7.12.1#712002)