Skip to content

Commit

Permalink
feat(process): better looking process pages
Browse files Browse the repository at this point in the history
  • Loading branch information
@jgeluk
jgeluk committed Sep 14, 2022
1 parent da3322e commit 4303197
Show file tree
Hide file tree
Showing 8 changed files with 255 additions and 213 deletions.
10 changes: 5 additions & 5 deletions Makefile
View file
Original file line number Diff line number Diff line change
Expand Up @@ -162,11 +162,11 @@ docs-install-special-python-packages: docs-install-pdf-python-packages docs-inst
.PHONY: docs-install-pdf-python-packages
docs-install-pdf-python-packages:
@#echo "Install PDF python packages via pip:"
# $(VENV_PIP) install --upgrade weasyprint
cd ../mkdocs-with-pdf && $(VENV_PIP) install -e .
#$(VENV_PIP) install --upgrade mkdocs-with-pdf
#$(VENV_PIP) install --upgrade weasyprint==52
#$(VENV_PIP) install --upgrade mkpdfs-mkdocs
@#$(VENV_PIP) install --upgrade weasyprint
@#cd ../mkdocs-with-pdf && $(VENV_PIP) install -e .
@#$(VENV_PIP) install --upgrade mkdocs-with-pdf
@#$(VENV_PIP) install --upgrade weasyprint==52
@#$(VENV_PIP) install --upgrade mkpdfs-mkdocs

.PHONY: docs-install-mkdocs-insider-version-packages
docs-install-mkdocs-insider-version-packages:
Expand Down
165 changes: 87 additions & 78 deletions docs/process/build/index.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -6,23 +6,70 @@ hide:
---
# Build

!!! info inline end "no-code"

In general, for most use cases, there is very little actual
coding involved since the majority of use cases can be done
in a ”low-code” or even ”no-code” manner by specifying all
details of all functional requirements in the context of the
UCT which then all ends up as ”executable models” in the
EKG itself.

<!--summary-build-start-->
_"Building" an EKG-based use case involves
everything from detailed requirements gathering---structured
around the Use Case Tree---all the way up to delivery of
components for your production EKG-platform._
<!--summary-build-end-->

??? info "Inputs"
=== "Intro"

**<!--summary-build-start-->
_"Building" an EKG-based use case involves
everything from detailed requirements gathering---structured
around the Use Case Tree---all the way up to delivery of
components for your production EKG-platform._
<!--summary-build-end-->**

!!! info "no-code"

In general, for most use cases, there is very little actual
coding (or "building") involved since the majority of use cases
can be done in a ”low-code” or even ”no-code” manner by specifying all
details of all functional requirements in the context of the
UCT which then all ends up as ”executable models” in the
EKG itself.
Most of the actual "building" of the use case consists of
adding more detail to the use case at hand. Capturing more knowledge
about it. Once enough detail has been specified, it runs, job done.

=== "Steps"

<div class="grid cards" markdown>

- :material-cached:{ .lg } __Allocate__

{% include-markdown "allocate.md"
start="<!--summary-start-->" end="<!--summary-end-->" %}
[:octicons-arrow-right-24: Learn more](allocate.md)

- :material-cached:{ .lg } __Design__

{% include-markdown "design.md"
start="<!--summary-start-->" end="<!--summary-end-->" %}
[:octicons-arrow-right-24: Learn more](design.md)

- :material-cached:{ .lg } __Implement__

{% include-markdown "implement.md"
start="<!--summary-start-->" end="<!--summary-end-->" %}
[:octicons-arrow-right-24: Learn more](implement.md)

- :material-cached:{ .lg } __Test__

{% include-markdown "test.md"
start="<!--summary-start-->" end="<!--summary-end-->" %}
[:octicons-arrow-right-24: Learn more](test.md)

- :material-cached:{ .lg } __Verify__

{% include-markdown "verify.md"
start="<!--summary-start-->" end="<!--summary-end-->" %}
[:octicons-arrow-right-24: Learn more](verify.md)

- :material-cached:{ .lg } __Deliver__

{% include-markdown "deliver.md"
start="<!--summary-start-->" end="<!--summary-end-->" %}
[:octicons-arrow-right-24: Learn more](deliver.md)

</div>

=== "Inputs"

To set up for success, it is essential that the build phase starts with
the following artifacts and results that are created during the [plan phase](../plan)
Expand All @@ -48,64 +95,26 @@ components for your production EKG-platform._
of what a successful delivery of the selected use cases means,
ideally around agreed business outcomes.

??? info "Critical success factors"

1. Creating an EKG can only be successful if it is done as part of the
company’s strategy with solid top-down support and leadership.
2. Bottom-up development of just one Knowledge Graph Use Case will only
lead to "yet another silo (YAS)" and cannot realistically compete
with existing technology stacks, missing out on the actual benefits
that EKG can provide.
3. An EKG requires internal ownership and a team that understands
the many new paradigms that are involved.
- Creating a solid team---let's call it the [Center of Excellence (CoE)
for the EKG](../../vocab/coe)---is essential.
4. It is not the technology that holds us back---the technology works---it
is the internal organization’s readiness and level of maturity in a
number of areas that require focus. (See [assess](../plan/assess.md))
5. A structured method is required that covers all areas, from strategy
and idea inception to capturing the right business outcomes and
requirements all the way to delivering a use case in production
and supporting it during its life cycle.
6. Any investment in a properly executed [plan phase](../plan) will
drastically increase the likelihood of successful delivery.

<div class="grid cards" markdown>

- :material-cached:{ .lg } __Allocate__

{% include-markdown "allocate.md"
start="<!--summary-start-->" end="<!--summary-end-->" %}
[:octicons-arrow-right-24: Learn more](allocate.md)

- :material-cached:{ .lg } __Design__

{% include-markdown "design.md"
start="<!--summary-start-->" end="<!--summary-end-->" %}
[:octicons-arrow-right-24: Learn more](design.md)

- :material-cached:{ .lg } __Implement__

{% include-markdown "implement.md"
start="<!--summary-start-->" end="<!--summary-end-->" %}
[:octicons-arrow-right-24: Learn more](implement.md)

- :material-cached:{ .lg } __Test__

{% include-markdown "test.md"
start="<!--summary-start-->" end="<!--summary-end-->" %}
[:octicons-arrow-right-24: Learn more](test.md)

- :material-cached:{ .lg } __Verify__

{% include-markdown "verify.md"
start="<!--summary-start-->" end="<!--summary-end-->" %}
[:octicons-arrow-right-24: Learn more](verify.md)

- :material-cached:{ .lg } __Deliver__

{% include-markdown "deliver.md"
start="<!--summary-start-->" end="<!--summary-end-->" %}
[:octicons-arrow-right-24: Learn more](deliver.md)

</div>
=== "Critical success factors"

1. Creating an EKG can only be successful if it is done as part of the
company’s strategy with solid top-down support and leadership.
- Bottom-up development of just one Knowledge Graph Use Case will only
lead to "yet another silo (YAS)" and cannot realistically compete
with existing technology stacks, missing out on the actual benefits
that EKG can provide.
3. An EKG requires internal ownership and a team that understands
the many new paradigms that are involved.
- Creating a solid team---let's call it the [Center of Excellence (CoE)
for the EKG](../../vocab/coe)---is essential.
- It is not the technology that holds us back---the technology works---it
is the internal organization’s readiness and level of maturity in a
number of areas that require focus.
Perform a solid [maturity assessment](../plan/assess.md).
5. A [structured method](https://method.ekgf.org) is required that covers
all areas, from strategy and idea inception to capturing the right
business outcomes and requirements all the way to delivering a
use case in production and supporting it during its life cycle.
6. Any investment in a properly executed [plan phase](../plan) will
drastically increase the likelihood of successful delivery.

74 changes: 38 additions & 36 deletions docs/process/index.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -5,39 +5,41 @@ hide:
---
# Process

<div class="grid cards" markdown>

[//]: # (* :material-cached:{ .lg } __Plan__)

[//]: # ()
[//]: # ( {% include-markdown "plan/index.md")

[//]: # ( start="<!--summary-plan-start-->" end="<!--summary-plan-end-->" %})

[//]: # ( [:octicons-arrow-right-24: Learn more]&#40;./plan/&#41;)

[//]: # (* :material-cached:{ .lg } __Build__)

[//]: # ()
[//]: # ( {% include-markdown "build/index.md")

[//]: # ( start="<!--summary-build-start-->" end="<!--summary-build-end-->" %})

[//]: # ( [:octicons-arrow-right-24: Learn more]&#40;./build/&#41;)

[//]: # (* :material-cached:{ .lg } __Run__)

[//]: # ()
[//]: # ( {% include-markdown "run/index.md")

[//]: # ( start="<!--summary-run-start-->" end="<!--summary-run-end-->" %})

[//]: # ( [:octicons-arrow-right-24: Learn more]&#40;run&#41;)

</div>

[//]: # (<figure markdown>)

[//]: # (<object data="../diagrams/out/process.svg#darkable" type="image/svg+xml"></object>)

[//]: # (</figure>)
=== "Steps"

<div class="grid cards" markdown>

* :material-cached:{ .lg } __Plan__


{% include-markdown "plan/index.md"

start="<!--summary-plan-start-->" end="<!--summary-plan-end-->" %}

[:octicons-arrow-right-24: Learn more](./plan/)

* :material-cached:{ .lg } __Build__


{% include-markdown "build/index.md"

start="<!--summary-build-start-->" end="<!--summary-build-end-->" %}

[:octicons-arrow-right-24: Learn more](./build/)

* :material-cached:{ .lg } __Run__


{% include-markdown "run/index.md"

start="<!--summary-run-start-->" end="<!--summary-run-end-->" %}

[:octicons-arrow-right-24: Learn more](run)

</div>

=== "Diagram"

<figure markdown>
<object data="../diagrams/out/process.svg#darkable" type="image/svg+xml"></object>
</figure>
124 changes: 65 additions & 59 deletions docs/process/plan/index.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -11,62 +11,68 @@ hide:
---
# Plan

<!--summary-plan-start-->
_Think big, start small, rinse, repeat, accelerate._
<!--summary-plan-end-->

[//]: # (??? note "Rationale")

In most large organizations, there are many ways to justify a migration to a more data-centric and less
siloed operation. There are countless use cases where a more data-centric and “holistic” approach could
be extremely beneficial. Starting with EKG requires planning and preparation. Think big, start small.
Start with the right use case, the right business case, the right team, prepare for success.
Establishing an EKG can be seen as a journey, it’s generally not something that can be done in “three
months”, even though---with the right amount of planning and preparation---the first use case that can
be delivered can be done in such a short time-frame, it should fit in a larger vision and strategy. Proper
expectation management is key.

Since EKG brings in many new “paradigms”, it is crucial to have proper expectation management in place,
all relevant stakeholders in the given scope need to understand what it is that you’re trying to achieve,
what the longer-term vision behind it is, agree on that vision, whereby the first use cases need to be
very convincing and need to be delivered successfully.

That's what this method is for. See also all other [objectives](../../objective).

<div class="grid cards" markdown>

- :material-cached:{ .lg } __Envision__

{% include-markdown "envision.md"
start="<!--summary-start-->" end="<!--summary-end-->" %}
[:octicons-arrow-right-24: Learn more](envision.md)

- :material-cached:{ .lg } __Discover__

{% include-markdown "discover.md"
start="<!--summary-start-->" end="<!--summary-end-->" %}
[:octicons-arrow-right-24: Learn more](discover.md)

- :material-cached:{ .lg } __Assess__

{% include-markdown "assess.md"
start="<!--summary-start-->" end="<!--summary-end-->" %}
[:octicons-arrow-right-24: Learn more](assess.md)

- :material-cached:{ .lg } __Train__

{% include-markdown "train.md"
start="<!--summary-start-->" end="<!--summary-end-->" %}
[:octicons-arrow-right-24: Learn more](train.md)

- :material-cached:{ .lg } __Chart__

{% include-markdown "chart.md"
start="<!--summary-start-->" end="<!--summary-end-->" %}
[:octicons-arrow-right-24: Learn more](chart.md)

</div>

<figure markdown>
<object data="../../diagrams/out/process-plan.svg#darkable" type="image/svg+xml"></object>
</figure>
=== "Intro"

**<!--summary-plan-start-->
_Think big, start small, rinse, repeat, accelerate._
<!--summary-plan-end-->**

[//]: # (??? note "Rationale")

In most large organizations, there are many ways to justify a migration to a more data-centric and less
siloed operation. There are countless use cases where a more data-centric and “holistic” approach could
be extremely beneficial. Starting with EKG requires planning and preparation. Think big, start small.
Start with the right use case, the right business case, the right team, prepare for success.
Establishing an EKG can be seen as a journey, it’s generally not something that can be done in “three
months”, even though---with the right amount of planning and preparation---the first use case that can
be delivered can be done in such a short time-frame, it should fit in a larger vision and strategy. Proper
expectation management is key.

Since EKG brings in many new “paradigms”, it is crucial to have proper expectation management in place,
all relevant stakeholders in the given scope need to understand what it is that you’re trying to achieve,
what the longer-term vision behind it is, agree on that vision, whereby the first use cases need to be
very convincing and need to be delivered successfully.

That's what this method is for. See also all other [objectives](../../objective).

=== "Steps"

<div class="grid cards" markdown>

- :material-cached:{ .lg } __Envision__

{% include-markdown "envision.md"
start="<!--summary-start-->" end="<!--summary-end-->" %}
[:octicons-arrow-right-24: Learn more](envision.md)

- :material-cached:{ .lg } __Discover__

{% include-markdown "discover.md"
start="<!--summary-start-->" end="<!--summary-end-->" %}
[:octicons-arrow-right-24: Learn more](discover.md)

- :material-cached:{ .lg } __Assess__

{% include-markdown "assess.md"
start="<!--summary-start-->" end="<!--summary-end-->" %}
[:octicons-arrow-right-24: Learn more](assess.md)

- :material-cached:{ .lg } __Train__

{% include-markdown "train.md"
start="<!--summary-start-->" end="<!--summary-end-->" %}
[:octicons-arrow-right-24: Learn more](train.md)

- :material-cached:{ .lg } __Chart__

{% include-markdown "chart.md"
start="<!--summary-start-->" end="<!--summary-end-->" %}
[:octicons-arrow-right-24: Learn more](chart.md)

</div>

=== "Diagram"

<figure markdown>
<object data="../../diagrams/out/process-plan.svg#darkable" type="image/svg+xml"></object>
</figure>
Loading

0 comments on commit 4303197

Please sign in to comment.