Skip to content

Commit

Permalink
docs(bpmn-copilot): add example prompts (#5046)
Browse files Browse the repository at this point in the history
* docs(bpmn-copilot): add example prompts

* docs(bpmn-copilot): add more sample prompts

* docs(bpmn-copilot): add idea to paste in existing documentation

* docs(bpmn-copilot): add suggested paste prompts

Co-authored-by: Eric Lundberg <ericlundberg09@gmail.com>

* docs(bpmn-copilot): grammar

* docs(bpmn-copilot): sentence structure

* docs(bpmn-copilot): add follow-up prompts

Co-authored-by: Eric Lundberg <ericlundberg09@gmail.com>

* docs(bpmn-copilot): cleanup and more additions

* docs(bpmn-copilot): Apply suggestions from code review

Co-authored-by: github-actions[bot] <41898282+github-actions[bot]@users.noreply.github.com>

* docs(bpmn-copilot): copy changes to 8.7 dir

* docs(bpmn-copilot): fix grammar

---------

Co-authored-by: Eric Lundberg <ericlundberg09@gmail.com>
Co-authored-by: github-actions[bot] <41898282+github-actions[bot]@users.noreply.github.com>
  • Loading branch information
3 people authored Feb 25, 2025
1 parent 7e6b112 commit 676b81e
Show file tree
Hide file tree
Showing 2 changed files with 52 additions and 2 deletions.
27 changes: 26 additions & 1 deletion docs/components/early-access/alpha/bpmn-copilot/bpmn-copilot.md
Original file line number Diff line number Diff line change
Expand Up @@ -38,7 +38,32 @@ Timeouts may occur at this step if your query is too complex.

:::

### Example prompts

- "Create an absence request diagram"
- "Design a process that uses data objects to drive process logic, showing how data influences process flow and decisions"
- "Model a complex service orchestration process involving multiple service tasks, conditional routing, and parallel execution of tasks"
- "Create a service order management process for a telco company. The process starts with a fraud check. First, calculate price dimensions via a script task, then check if the price dimensions are normal or high with an exclusive gateway. If high, escalate to a fraud investigation subprocess."
- Paste existing text documentation of a process or of process requirements (for example, a Confluence page)
- Paste a process hard-coded in any language (for example, BPEL, Java, COBOL, Python)
- Paste a description of a diagram. Any LLM (like ChatGPT) can generate this description from a screenshot or an image of the diagram.

## Follow-up prompts

The BPMN Copilot can also translate business-focused intent into actionable changes for the diagram it creates. For example:

- "Modify this process to maximize its changes of adhering to a 1 day SLA"
- "Reduce the operating cost of this process"
- "Show me ways to integrate AI into the process"
- "Consider unhappy paths as well"
- "Add error handling"
- "Improve the user experience"

:::note
Requesting specific modifications to one or several sections of the BPMN diagram may impact unrelated sections.
:::

### Limitations

- The BPMN Copilot does not officially support modifying existing diagrams (including diagrams with implementation details).
- The BPMN Copilot officially supports only modifying diagrams that were created by the BPMN Copilot itself. It does not officially support modifying other existing diagrams (including diagrams with implementation details).
- The BPMN Copilot does not support pools, lanes, and collaborations.
Original file line number Diff line number Diff line change
Expand Up @@ -38,7 +38,32 @@ Timeouts may occur at this step if your query is too complex.

:::

### Example prompts

- "Create an absence request diagram"
- "Design a process that uses data objects to drive process logic, showing how data influences process flow and decisions"
- "Model a complex service orchestration process involving multiple service tasks, conditional routing, and parallel execution of tasks"
- "Create a service order management process for a telco company. The process starts with a fraud check. First, calculate price dimensions via a script task, then check if the price dimensions are normal or high with an exclusive gateway. If high, escalate to a fraud investigation subprocess."
- Paste existing text documentation of a process or of process requirements (for example, a Confluence page)
- Paste a process hard-coded in any language (for example, BPEL, Java, COBOL, Python)
- Paste a description of a diagram. Any LLM (like ChatGPT) can generate this description from a screenshot or an image of the diagram.

## Follow-up prompts

The BPMN Copilot can also translate business-focused intent into actionable changes for the diagram it creates. For example:

- "Modify this process to maximize its changes of adhering to a 1 day SLA"
- "Reduce the operating cost of this process"
- "Show me ways to integrate AI into the process"
- "Consider unhappy paths as well"
- "Add error handling"
- "Improve the user experience"

:::note
Requesting specific modifications to one or several sections of the BPMN diagram may impact unrelated sections.
:::

### Limitations

- The BPMN Copilot does not officially support modifying existing diagrams (including diagrams with implementation details).
- The BPMN Copilot officially supports only modifying diagrams that were created by the BPMN Copilot itself. It does not officially support modifying other existing diagrams (including diagrams with implementation details).
- The BPMN Copilot does not support pools, lanes, and collaborations.

0 comments on commit 676b81e

Please sign in to comment.