Skip to content

Commit 137b20d

Browse files
committed
Add section regarding workflows
1 parent 70c79bf commit 137b20d

File tree

1 file changed

+6
-13
lines changed

1 file changed

+6
-13
lines changed

doc/design.rst

Lines changed: 6 additions & 13 deletions
Original file line numberDiff line numberDiff line change
@@ -430,23 +430,16 @@ Workflows Dependency Structure
430430
++++++++++++++++++++++++++++++
431431

432432
**Description:**
433-
The common Workflows have been undergooging common and frequent changes, as their full
434-
required features are still discovered. Therfore no clear interface and reqruirements
435-
on the workflow "interfaces" have been documented. Currently it is with most workflows
436-
either get all of them or understand what they do and exchange before one can easily
437-
customize the workflows.
433+
Undocumented workflow interdependencies and structure
438434

439435
**Downsides:**
440-
441-
- Lack of clear documentation and structure for workflow dependencies.
436+
- Hard to customize if one does not understand the overall setup and dependencies
442437

443438
**Rationale/History:**
444-
445-
- Proper documentation will streamline workflow management and dependency tracing.
446-
- Workflow dependencies were initially structured without thorough documentation.
439+
- Simplify development during the discovery phase (what is needed, how to implement, adjust to discovered needs)
440+
- Ideally, all workflows will be integrated and use a standard setup (part of the customization can also be done in the called nox tasks)
447441

448442
**Ideas/Possible Solutions:**
449443

450-
- Work out and document dependencies and structure thoroughly.
451-
- Develop a visual or diagrammatic representation to aid comprehension.
452-
- Regularly review and update the documentation to stay current with project evolution.
444+
- Define clear requirements and interfaces
445+
- Document those requirements and interfaces

0 commit comments

Comments
 (0)