-
-
Notifications
You must be signed in to change notification settings - Fork 11
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
v6.12 release docs (VDAD release) (#96)
- Loading branch information
Showing
24 changed files
with
664 additions
and
1 deletion.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,113 @@ | ||
| --- | ||
| title: Stakeholders | ||
| permalink: /docs/stakeholders/ | ||
| --- | ||
|
|
||
| The CML language supports the modelling of [stakeholders](https://en.wikipedia.org/wiki/Project_stakeholder) of (digital) solutions and/or projects. This feature has been introduced to support the [Value-Driven Analysis and Design (VDAD)](https://ethical-se.github.io/value-driven-analysis-and-design) process. One part of this process supporting ethical software engineering is the identification of all relevant stakeholders. For more information about the whole process we refer to the [VDAD page](https://ethical-se.github.io/value-driven-analysis-and-design). However, modelling stakeholders can support your requirements engineering process in different ways; no matter whether you apply VDAD practices or not. | ||
|
|
||
| **Note**: With our [PlantUML generator](/docs/plant-uml/) you can automatically generate [Stakeholder Maps](https://ethical-se.github.io/value-driven-analysis-and-design/practices/stakeholder-mapping), once you modelled all your stakeholders and stakeholder groups. See example below. | ||
|
|
||
| ## Stakeholders Container | ||
| On the root level of a CML file, one first needs to create a `Stakeholders` container. This can be done as simply as follows: | ||
|
|
||
| <div class="highlight"><pre><span></span><span class="k">Stakeholders</span> { | ||
|
|
||
| <span class="c1">// add stakeholders and stakeholder groups here</span> | ||
|
|
||
| } | ||
| </pre></div> | ||
|
|
||
| However, if you want to model the stakeholders for a specific [Bounded Context](/docs/bounded-context/), you can declare that as follows: | ||
|
|
||
| <pre class="highlight"><span class="k">BoundedContext</span> ExampleContext | ||
|
|
||
| <span class="k">Stakeholders</span> <span class="k">of</span> ExampleContext { | ||
|
|
||
| <span class="c1">// add stakeholders and stakeholder groups here</span> | ||
|
|
||
| } | ||
| </pre> | ||
|
|
||
| ## Stakeholders | ||
| Inside a `Stakeholders` container, you can define your stakeholders. This can be done with the `Stakeholder` keyword an the name of the stakeholder: | ||
|
|
||
| <div class="highlight"><div class="highlight"><pre><span></span><span class="k">BoundedContext</span> <span class="n">ExampleContext</span> | ||
|
|
||
| <span class="k">Stakeholders</span> <span class="k">of</span> <span class="n">ExampleContext</span> <span class="p">{</span> | ||
|
|
||
| <span class="k">Stakeholder</span> <span class="n">Shopper</span> | ||
|
|
||
| <span class="k">Stakeholder</span> <span class="n">Software_Engineer</span> | ||
|
|
||
| <span class="k">Stakeholder</span> <span class="n">Architect</span> | ||
|
|
||
| <span class="c1">// etc.</span> | ||
|
|
||
| <span class="p">}</span> | ||
| </pre></div> | ||
| </div> | ||
|
|
||
| In addition, you can provide additional information for a stakeholder using the `description`, `influence` and `interest` keywords: | ||
|
|
||
| <div class="highlight"><div class="highlight"><pre><span></span><span class="k">BoundedContext</span> <span class="n">ExampleContext</span> | ||
|
|
||
| <span class="k">Stakeholders</span> <span class="k">of</span> <span class="n">ExampleContext</span> <span class="p">{</span> | ||
|
|
||
| <span class="k">Stakeholder</span> <span class="n">Shopper</span> <span class="p">{</span> | ||
| <span class="k">description</span> <span class="s">"Is using the shopping system to by everday goods."</span> | ||
|
|
||
| <span class="k">influence</span> <span class="k">MEDIUM</span> | ||
| <span class="k">interest</span> <span class="k">HIGH</span> | ||
| <span class="p">}</span> | ||
|
|
||
| <span class="p">}</span> | ||
| </pre></div> | ||
| </div> | ||
|
|
||
| The `description` just describes why and/or how the stakeholder uses the system or is impacted by the system. As suggested by many stakeholder mapping tutorials (see [Miro](https://miro.com/blog/stakeholder-mapping/) or [Mural](https://www.mural.co/blog/stakeholder-mapping)), you can define what the `influence` of the stakeholders is and how much they are interested (`interest`) in the new system or feature. | ||
|
|
||
| ## Stakeholder Groups | ||
| Stakeholder maps often group stakeholders of similar roles or with similar interest together. This is also possible in CML with the `StakeholderGroup` keyword, which can again contain stakeholders with the `Stakeholder` keyword: | ||
|
|
||
| <div class="highlight"><div class="highlight"><pre><span></span><span class="k">BoundedContext</span> <span class="n">ExampleContext</span> | ||
|
|
||
| <span class="k">Stakeholders</span> <span class="k">of</span> <span class="n">ExampleContext</span> <span class="p">{</span> | ||
|
|
||
| <span class="k">StakeholderGroup</span> <span class="n">Online_Shopping_Company</span> <span class="p">{</span> | ||
| <span class="k">Stakeholder</span> <span class="n">Development_Team</span> <span class="p">{</span> | ||
| <span class="k">influence</span> <span class="k">MEDIUM</span> | ||
| <span class="k">interest</span> <span class="k">HIGH</span> | ||
| <span class="p">}</span> | ||
| <span class="k">Stakeholder</span> <span class="n">Product_Management</span> <span class="p">{</span> | ||
| <span class="k">influence</span> <span class="k">HIGH</span> | ||
| <span class="k">interest</span> <span class="k">HIGH</span> | ||
| <span class="p">}</span> | ||
| <span class="k">Stakeholder</span> <span class="n">Customer_Relationship_Manager</span> <span class="p">{</span> | ||
| <span class="k">influence</span> <span class="k">HIGH</span> | ||
| <span class="k">interest</span> <span class="k">MEDIUM</span> | ||
| <span class="p">}</span> | ||
| <span class="p">}</span> | ||
|
|
||
| <span class="k">Stakeholder</span> <span class="n">Shopper</span> <span class="p">{</span> | ||
| <span class="k">description</span> <span class="s">"Is using the shopping system to by everday goods."</span> | ||
|
|
||
| <span class="k">influence</span> <span class="k">MEDIUM</span> | ||
| <span class="k">interest</span> <span class="k">HIGH</span> | ||
| <span class="p">}</span> | ||
|
|
||
| <span class="p">}</span> | ||
| </pre></div> | ||
| </div> | ||
|
|
||
| ## Visualization: Stakeholder Map | ||
| Once your stakeholders are modelled in CML, you can generate a visual stakeholder map automatically. Here is an example: | ||
|
|
||
|  | ||
|
|
||
| Check out our [PlantUML generator](/docs/plant-uml/) on how to generate such a diagram. | ||
|
|
||
| ## Stakeholders Export to CSV | ||
| In addition to the Stakeholder Map visualization, you can export your modelled stakeholder data as a CSV file. To do so, use the Freemarker temple [here](https://raw.githubusercontent.com/ContextMapper/context-mapper-dsl/master/org.contextmapper.dsl.ui/samples/freemarker/csv-files/stakeholders.csv.ftl) together with our [Generic Generator (Freemarker Templating)](/docs/generic-freemarker-generator/). | ||
|
|
||
| ## Transformations | ||
| Note that we offer several transformations that might help modelling stakeholders and their values according to [VDAD (Value-Driven Analysis and Design)](https://ethical-se.github.io/value-driven-analysis-and-design) more efficiently. The transformations are documented on the following page: [Stakeholder and Value Modelling Transformations](/docs/stakeholder-and-value-modelling-transformations/) |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Oops, something went wrong.