qgraphflow 0.0.6 → 0.0.7
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/.claude-plugin/marketplace.json +1 -1
- package/.claude-plugin/plugin.json +1 -1
- package/.codex-plugin/plugin.json +2 -2
- package/.cursor-plugin/plugin.json +1 -1
- package/.qoder-plugin/plugin.json +1 -1
- package/README.md +119 -70
- package/docs/clients.de.md +15 -24
- package/docs/clients.es.md +15 -24
- package/docs/clients.ja.md +15 -24
- package/docs/clients.md +15 -24
- package/docs/clients.pt.md +15 -24
- package/docs/clients.ru.md +15 -24
- package/docs/clients.zh-CN.md +15 -24
- package/docs/readme/README.de.md +120 -71
- package/docs/readme/README.es.md +120 -71
- package/docs/readme/README.ja.md +120 -71
- package/docs/readme/README.pt.md +120 -71
- package/docs/readme/README.ru.md +120 -71
- package/docs/readme/README.zh-CN.md +106 -59
- package/examples/jeepay/README.md +23 -0
- package/examples/jeepay/capabilities.graph.json +270 -0
- package/examples/jeepay/class.graph.json +237 -0
- package/examples/jeepay/collection.graph.json +3057 -0
- package/examples/jeepay/dataflow.graph.json +212 -0
- package/examples/jeepay/deployment.graph.json +222 -0
- package/examples/jeepay/engineering.graph.json +277 -0
- package/examples/jeepay/er.graph.json +482 -0
- package/examples/jeepay/flowchart.graph.json +312 -0
- package/examples/jeepay/relations.graph.json +289 -0
- package/examples/jeepay/sequence.graph.json +355 -0
- package/examples/jeepay/source.json +95 -0
- package/examples/jeepay/state.graph.json +175 -0
- package/examples/jeepay/usecase.graph.json +222 -0
- package/package.json +14 -3
- package/skills/q-flow/SKILL.md +28 -20
- package/skills/q-flow/agents/openai.yaml +1 -1
- package/skills/q-flow/assets/viewer/package.json +1 -1
- package/skills/q-flow/assets/viewer/src/architecture-overview-theme.js +22 -0
- package/skills/q-flow/assets/viewer/src/architecture-overview.js +340 -0
- package/skills/q-flow/assets/viewer/src/diagrams/architecture.js +8 -5
- package/skills/q-flow/assets/viewer/src/diagrams/card.js +35 -17
- package/skills/q-flow/assets/viewer/src/diagrams/deployment.js +7 -5
- package/skills/q-flow/assets/viewer/src/diagrams/drawing.js +5 -2
- package/skills/q-flow/assets/viewer/src/diagrams/registry.js +10 -0
- package/skills/q-flow/assets/viewer/src/diagrams/sequence.js +13 -7
- package/skills/q-flow/assets/viewer/src/edge-routing.js +43 -22
- package/skills/q-flow/assets/viewer/src/export-svg.js +27 -5
- package/skills/q-flow/assets/viewer/src/graph-validation.js +72 -15
- package/skills/q-flow/assets/viewer/src/i18n-messages.json +184 -8
- package/skills/q-flow/assets/viewer/src/layout-compaction.js +123 -0
- package/skills/q-flow/assets/viewer/src/layout-measure.js +14 -8
- package/skills/q-flow/assets/viewer/src/layout-policy.js +6 -0
- package/skills/q-flow/assets/viewer/src/layout-quality.js +61 -15
- package/skills/q-flow/assets/viewer/src/layout-refinement.js +271 -0
- package/skills/q-flow/assets/viewer/src/layout-semantics.js +8 -0
- package/skills/q-flow/assets/viewer/src/layout-spacing.js +23 -4
- package/skills/q-flow/assets/viewer/src/layout-templates.js +298 -0
- package/skills/q-flow/assets/viewer/src/node-svg.js +1 -1
- package/skills/q-flow/assets/viewer/src/orthogonal-routing.js +475 -0
- package/skills/q-flow/assets/viewer/src/presentation-graph.js +31 -0
- package/skills/q-flow/assets/viewer/src/route-clearance.js +144 -0
- package/skills/q-flow/assets/viewer/src/sequence-executions.js +22 -0
- package/skills/q-flow/assets/viewer/src/sequence-fragments.js +20 -2
- package/skills/q-flow/assets/viewer/src/session-graph.js +46 -3
- package/skills/q-flow/assets/viewer/src/text-layout.js +33 -6
- package/skills/q-flow/assets/viewer/src/view-identity.js +26 -0
- package/skills/q-flow/assets/viewer/src/visual-style.js +13 -5
- package/skills/q-flow/assets/viewer-dist/index.html +30 -28
- package/skills/q-flow/references/evidence-sources.md +7 -5
- package/skills/q-flow/references/graph-common.md +34 -34
- package/skills/q-flow/references/graph-schema.md +28 -7
- package/skills/q-flow/references/guided-intake.md +51 -71
- package/skills/q-flow/references/layout-routing.md +47 -0
- package/skills/q-flow/references/types/architecture.md +42 -22
- package/skills/q-flow/references/types/class.md +9 -2
- package/skills/q-flow/references/types/dataflow.md +11 -4
- package/skills/q-flow/references/types/deployment.md +11 -3
- package/skills/q-flow/references/types/er.md +8 -1
- package/skills/q-flow/references/types/flowchart.md +12 -5
- package/skills/q-flow/references/types/sequence.md +20 -16
- package/skills/q-flow/references/types/state.md +10 -3
- package/skills/q-flow/references/types/usecase.md +6 -0
- package/skills/q-flow/references/viewer-development.md +37 -24
- package/skills/q-flow/references/visual-contract.md +12 -6
- package/skills/q-flow/scripts/compile-layout.mjs +85 -102
- package/skills/q-flow/scripts/compile-sequence.mjs +4 -21
- package/skills/q-flow/scripts/generate-viewer.mjs +18 -9
- package/skills/q-flow/scripts/validate-graph.mjs +38 -21
- package/examples/order-flow.graph.json +0 -94
package/docs/readme/README.de.md
CHANGED
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
<div align="center">
|
|
2
2
|
|
|
3
|
-
|
|
3
|
+
<h1><picture><source media="(prefers-color-scheme: dark)" srcset="../images/brand/qgraphflow-lockup-dark.svg"><img src="../images/brand/qgraphflow-lockup-light.svg" alt="QGraphFlow" height="64"></picture></h1>
|
|
4
4
|
|
|
5
5
|
### Aus komplexem Code werden Diagramme zum Erkunden.
|
|
6
6
|
|
|
@@ -10,17 +10,25 @@ Pfade verfolgen. Belege prüfen. Eine Offline-Datei teilen.
|
|
|
10
10
|
|
|
11
11
|
[English](../../README.md) · [中文](../../docs/readme/README.zh-CN.md) · [Русский](../../docs/readme/README.ru.md) · [Português](../../docs/readme/README.pt.md) · [日本語](../../docs/readme/README.ja.md) · [Deutsch](../../docs/readme/README.de.md) · [Español](../../docs/readme/README.es.md)
|
|
12
12
|
|
|
13
|
-
[Online-Demo](https://supermax92.github.io/qgraphflow/) · [Client-Installation](#installationsanleitung) · [Problem melden](https://github.com/supermax92/qgraphflow/issues) · [MIT](../../LICENSE)
|
|
13
|
+
[Online-Demo](https://supermax92.github.io/qgraphflow/) · [Erste Schritte](#erste-schritte) · [Client-Installation](#installationsanleitung) · [Problem melden](https://github.com/supermax92/qgraphflow/issues) · [MIT](../../LICENSE)
|
|
14
14
|
|
|
15
15
|
</div>
|
|
16
16
|
|
|
17
|
-
|
|
18
|
-
|
|
19
|
-
*Neun Diagrammarten: Architektur, Flussdiagramm, Sequenz, ER, Bereitstellung, Klasse, Zustand, Anwendungsfall und Datenfluss.*
|
|
17
|
+
*Elf Diagrammarten: Plattformfähigkeitsarchitektur, Architektur der Engineering-Schichten, Komponentenbeziehungsarchitektur, Flussdiagramm, Sequenz, ER, Bereitstellung, Klasse, Zustand, Anwendungsfall und Datenfluss.*
|
|
20
18
|
|
|
21
19
|
QGraphFlow erzeugt interaktive Softwarediagramme aus Quellcode, Datenstrukturen, Konfiguration und Anforderungen. Beziehungen bleiben überprüfbar; das Ergebnis lässt sich als Offline-HTML teilen.
|
|
22
20
|
|
|
23
|
-
**Was es auszeichnet:**
|
|
21
|
+
**Was es auszeichnet:** elf Diagrammarten in einem Skill, eine Belegart für jede Beziehung und die Quellzeile hinter jeder durch Code gestützten, automatisches Layout, Bearbeiten direkt auf der Seite und keine Netzwerkanfragen von den Plugin-Skripten oder dem Viewer selbst.
|
|
22
|
+
|
|
23
|
+

|
|
24
|
+
|
|
25
|
+
Wechsle anhand des echten Jeepay-Quellcodes zwischen Komponentenbeziehungsarchitektur, Sequenz- und ER-Diagrammen, um Komponenten und Aufrufbeziehungen zu erkunden. [GIF in Originalgröße ansehen](https://github.com/supermax92/qgraphflow/releases/download/showcase-v2/jeepay.en.hero.gif)
|
|
26
|
+
|
|
27
|
+
**Präsentation eines komplexen Sequenzdiagramms**
|
|
28
|
+
|
|
29
|
+

|
|
30
|
+
|
|
31
|
+
Ein fiktives E-Commerce-Szenario enthält 9 Teilnehmer, 29 Nachrichten und 6 kombinierte Fragmente mit Bestandswiederholungen, verschachtelten Zweigen, paralleler Verarbeitung, Fehlerkompensation und asynchronen Rückrufen. Die Animation zeigt das erzeugte Diagramm schrittweise und macht seine Struktur und Details sichtbar. [GIF in Originalgröße ansehen](https://github.com/supermax92/qgraphflow/releases/download/showcase-v2/checkout.en.sequence-drawing.gif)
|
|
24
32
|
|
|
25
33
|
```bash
|
|
26
34
|
npx skills add supermax92/qgraphflow
|
|
@@ -30,21 +38,67 @@ Ein Befehl installiert den Skill für Claude Code, Codex, Cursor und Qoder; die
|
|
|
30
38
|
|
|
31
39
|
- **Erkunden:** suchen, zoomen und verschieben; Verantwortlichkeiten sowie ein- und ausgehende Beziehungen verstehen.
|
|
32
40
|
|
|
33
|
-

|
|
34
|
-
|
|
35
41
|
- **Prüfen:** Dateien, Zeilen, Symbole und ausdrücklich gekennzeichnete Unsicherheiten an Knoten und Kanten untersuchen.
|
|
36
42
|
|
|
37
|
-

|
|
38
|
-
|
|
39
43
|
- **Bearbeiten:** Layout entsperren, Texte ändern und Elemente verschieben; bei Bedarf zurücksetzen.
|
|
40
44
|
|
|
41
|
-

|
|
42
|
-
|
|
43
45
|
- **Teilen:** Offline-HTML öffnen oder das vollständige Diagramm als SVG / PNG exportieren.
|
|
44
46
|
|
|
45
|
-
|
|
47
|
+
Der auf echtem Quellcode beruhende [Jeepay-Korpus](../../examples/jeepay) enthält alle elf Ansichten, die CI und die Online-Demo verwenden.
|
|
48
|
+
|
|
49
|
+
## Erste Schritte
|
|
50
|
+
|
|
51
|
+
Öffne nach der Installation dein Geschäftsprojekt im Client und wähle den Skill `q-flow`. Die Beispiele verwenden `/q-flow` in Claude Code; in Codex verwendest du den Eintrag `$q-flow` oder `$qgraphflow:q-flow`, den dein Client tatsächlich anbietet. Noch nicht installiert? Lies zuerst die [Installationsanleitung](#installationsanleitung).
|
|
52
|
+
|
|
53
|
+
### 1. Leere Eingabe: Du weißt nicht, wo du anfangen sollst
|
|
54
|
+
|
|
55
|
+
Rufe den Skill ohne zusätzliche Anforderungen auf:
|
|
56
|
+
|
|
57
|
+
```text
|
|
58
|
+
/q-flow
|
|
59
|
+
```
|
|
60
|
+
|
|
61
|
+
Der Skill hilft dir, den zu analysierenden Teil und die Frage auszuwählen, die das Diagramm beantworten soll. Sobald die nötigen Informationen geklärt sind, beginnt das Zeichnen.
|
|
62
|
+
|
|
63
|
+
### 2. Nach Fähigkeiten fragen: Erfahren, was er zeichnen kann
|
|
64
|
+
|
|
65
|
+
```text
|
|
66
|
+
/q-flow Welche Diagrammarten kannst du zeichnen? Welche Fragen beantwortet jede Art? Ich habe gerade ein Projekt übernommen; stelle deine Fähigkeiten vor und schlage einen Einstieg vor.
|
|
67
|
+
```
|
|
68
|
+
|
|
69
|
+
Lerne zuerst die Einsatzgebiete der elf Diagrammarten kennen. Entscheide dann, ob du Projektstruktur, Aufrufreihenfolge, Datenbeziehungen oder etwas anderes betrachten möchtest.
|
|
70
|
+
|
|
71
|
+
### 3. Vage Eingabe: Nur ein grobes Ziel
|
|
72
|
+
|
|
73
|
+
```text
|
|
74
|
+
/q-flow Hilf mir, dieses Projekt zu zeichnen. Ich möchte es möglichst schnell verstehen.
|
|
75
|
+
```
|
|
76
|
+
|
|
77
|
+
Du musst vorher keine Diagrammart angeben. Der Skill bestimmt anhand des Projekts und deines Ziels eine passende Ansicht und fragt nach, wenn notwendige Informationen fehlen.
|
|
78
|
+
|
|
79
|
+
### 4. Präzise Eingabe: Umfang festlegen und Zeichnungsdetails anfordern
|
|
80
|
+
|
|
81
|
+
Ersetze die folgenden Geschäftsbegriffe und Schritte durch Abläufe, die tatsächlich in deinem Projekt vorkommen:
|
|
82
|
+
|
|
83
|
+
```text
|
|
84
|
+
/q-flow Analysiere die Bestellerstellung im aktuellen Projekt und erzeuge ein Sequenzdiagramm auf Chinesisch.
|
|
85
|
+
Berücksichtige den Anfrageeingang, die Preisberechnung, Bestandsreservierung, Zahlungsautorisierung und Speicherung der Bestellung.
|
|
86
|
+
Erhalte die synchronen Aufrufe, asynchronen Nachrichten, gepaarten Rückgaben, Aktivierungsbalken, bedingten Zweige, Wiederholungen und Fehlerkompensationen, die tatsächlich im Quellcode vorkommen. Lasse keine Details zugunsten der Kürze weg.
|
|
87
|
+
Kennzeichne Quelldateien und Zeilennummern der Komponenten und Aufrufe und speichere das Ergebnis unter docs/qgraphflow/order-sequence/.
|
|
88
|
+
```
|
|
89
|
+
|
|
90
|
+
Benenne Gegenstand, Frage, Detailgrad und Ausgabeort klar, damit es direkt losgehen kann. Das Diagramm enthält nur durch Belege gestützte Fakten.
|
|
91
|
+
|
|
92
|
+
### 5. Weiter verfeinern: Einen Teil des letzten Diagramms vertiefen
|
|
93
|
+
|
|
94
|
+
Fahre nach der Erzeugung des Ergebnisses im selben Gespräch fort:
|
|
95
|
+
|
|
96
|
+
```text
|
|
97
|
+
/q-flow Vertiefe die Bestandsreservierung aus dem letzten Sequenzdiagramm als separates Flussdiagramm auf Chinesisch.
|
|
98
|
+
Zeige sämtliche Zweige für Bestandsprüfung, erfolgreiche Reservierung, wiederholbare Fehler, Wiederholungslimit und Bestandsfreigabe. Halte dich an den Quellcode und füge keine dort fehlenden Schritte hinzu.
|
|
99
|
+
```
|
|
46
100
|
|
|
47
|
-
|
|
101
|
+
Betrachte zuerst das Ganze und vertiefe dann einen Schritt. Du kannst auch weitere Details für ein vorhandenes Diagramm anfordern oder seine Beziehungen prüfen.
|
|
48
102
|
|
|
49
103
|
## Installationsanleitung
|
|
50
104
|
|
|
@@ -62,9 +116,18 @@ Für die Installation als Plugin den folgenden Schritten folgen. [Qoder Desktop]
|
|
|
62
116
|
|
|
63
117
|
### 1. Plugin herunterladen
|
|
64
118
|
|
|
65
|
-
|
|
119
|
+
Das Plugin von npmjs.com beziehen, ohne Konto, Anmeldung oder Token. Ein eigenes Verzeichnis außerhalb des Anwendungsprojekts erstellen:
|
|
120
|
+
|
|
121
|
+
```bash
|
|
122
|
+
mkdir qgraphflow-install
|
|
123
|
+
cd qgraphflow-install
|
|
124
|
+
npm install qgraphflow --ignore-scripts
|
|
125
|
+
cd node_modules/qgraphflow
|
|
126
|
+
```
|
|
127
|
+
|
|
128
|
+
Nun befindet man sich im Plugin-Stammverzeichnis. **Der Download über npm installiert das Plugin nicht automatisch im Client;** mit Schritt 2 fortfahren. Das Paket stellt außerdem den Befehl `qgraphflow` bereit, den [Diagramme mit dem Code synchron halten](#diagramme-mit-dem-code-synchron-halten) verwendet.
|
|
66
129
|
|
|
67
|
-
Alle folgenden Terminalbefehle im **
|
|
130
|
+
Alle folgenden Terminalbefehle im **Plugin-Stammverzeichnis mit `skills/`** ausführen.
|
|
68
131
|
|
|
69
132
|
### 2. Im gewünschten Client installieren
|
|
70
133
|
|
|
@@ -81,17 +144,8 @@ Eine neue Sitzung starten, `$` eingeben und `qgraphflow:q-flow` auswählen.
|
|
|
81
144
|
|
|
82
145
|
#### Claude Code
|
|
83
146
|
|
|
84
|
-
Direkt von GitHub installieren, ohne das ZIP herunterzuladen:
|
|
85
|
-
|
|
86
147
|
```bash
|
|
87
|
-
claude plugin marketplace add
|
|
88
|
-
claude plugin install qgraphflow@supermax92 --scope user
|
|
89
|
-
```
|
|
90
|
-
|
|
91
|
-
Oder aus dem entpackten Plugin-Stammverzeichnis:
|
|
92
|
-
|
|
93
|
-
```bash
|
|
94
|
-
claude plugin marketplace add .
|
|
148
|
+
claude plugin marketplace add ./
|
|
95
149
|
claude plugin install qgraphflow@supermax92 --scope user
|
|
96
150
|
```
|
|
97
151
|
|
|
@@ -107,9 +161,9 @@ Eine neue Sitzung starten und `q-flow` auswählen.
|
|
|
107
161
|
|
|
108
162
|
#### Qoder Desktop
|
|
109
163
|
|
|
110
|
-
**Empfohlen:** Öffne **Settings → Plugins → Marketplace**, suche nach
|
|
164
|
+
**Empfohlen:** Öffne **Settings → Plugins → Marketplace**, suche nach **QGraphFlow** oder **代码图谱可视化** und installiere das Plugin. Starte eine neue Sitzung und wähle `q-flow`.
|
|
111
165
|
|
|
112
|
-
Für eine lokale Installation führe zuerst Schritt 1 aus. Öffne dann **Settings → Plugins → Custom → Import** und importiere das vollständige
|
|
166
|
+
Für eine lokale Installation führe zuerst Schritt 1 aus. Öffne dann **Settings → Plugins → Custom → Import** und importiere das vollständige Plugin-Stammverzeichnis. Starte eine neue Sitzung und wähle `q-flow`.
|
|
113
167
|
|
|
114
168
|
#### Cursor
|
|
115
169
|
|
|
@@ -123,27 +177,11 @@ Prüfen, ob dort `.cursor-plugin/plugin.json` vorhanden ist, das Fenster neu lad
|
|
|
123
177
|
|
|
124
178
|
### 3. Loslegen
|
|
125
179
|
|
|
126
|
-
|
|
127
|
-
|
|
128
|
-
<details>
|
|
129
|
-
<summary>Alternative Installation: npm</summary>
|
|
130
|
-
|
|
131
|
-
Statt der ZIP-Datei kann das Plugin auch von npmjs.com bezogen werden, ohne Konto, Anmeldung oder Token. Ein eigenes Verzeichnis außerhalb des Anwendungsprojekts erstellen:
|
|
132
|
-
|
|
133
|
-
```bash
|
|
134
|
-
mkdir qgraphflow-install
|
|
135
|
-
cd qgraphflow-install
|
|
136
|
-
npm install qgraphflow --ignore-scripts
|
|
137
|
-
cd node_modules/qgraphflow
|
|
138
|
-
```
|
|
139
|
-
|
|
140
|
-
Nun im Plugin-Stammverzeichnis mit den Installationsschritten für den gewünschten Client oben fortfahren. **Der Download über npm installiert das Plugin nicht automatisch im Client.** Das Paket stellt außerdem den Befehl `qgraphflow` bereit, den [Diagramme mit dem Code synchron halten](#diagramme-mit-dem-code-synchron-halten) verwendet.
|
|
141
|
-
|
|
142
|
-
</details>
|
|
180
|
+
Öffne dein Geschäftsprojekt im Client, starte eine neue Sitzung und wähle den Skill. Beschreibe deine Anforderungen anhand der Beispiele unter [Erste Schritte](#erste-schritte). Öffne das erzeugte HTML im Browser.
|
|
143
181
|
|
|
144
182
|
Selbst bauen? Siehe [Anleitung zum Bauen aus dem Quellcode](https://github.com/supermax92/qgraphflow/blob/main/docs/distribution.md#prepare-locally).
|
|
145
183
|
|
|
146
|
-
##
|
|
184
|
+
## Schnell verwenden
|
|
147
185
|
|
|
148
186
|
Die Beispiele verwenden `$qgraphflow:q-flow` in Codex. Zeigt der Client `$q-flow`, diesen Eintrag wählen. In anderen Clients den oben beschriebenen Skill-Aufruf verwenden.
|
|
149
187
|
|
|
@@ -158,7 +196,7 @@ $qgraphflow:q-flow
|
|
|
158
196
|
### Beispiel 1: Projektarchitektur verstehen
|
|
159
197
|
|
|
160
198
|
```text
|
|
161
|
-
$qgraphflow:q-flow Analysiere dieses Projekt und erstelle ein
|
|
199
|
+
$qgraphflow:q-flow Analysiere dieses Projekt und erstelle ein chinesisches Architekturdiagramm mit Verantwortlichkeiten der Module, Abhängigkeiten und Systemgrenzen.
|
|
162
200
|
```
|
|
163
201
|
|
|
164
202
|
Geeignet, um sich erstmals einen Überblick über ein Projekt zu verschaffen.
|
|
@@ -166,13 +204,13 @@ Geeignet, um sich erstmals einen Überblick über ein Projekt zu verschaffen.
|
|
|
166
204
|
### Beispiel 2: Einen Geschäftsablauf verfolgen
|
|
167
205
|
|
|
168
206
|
```text
|
|
169
|
-
$qgraphflow:q-flow Analysiere die Bestellerstellung und erstelle ein
|
|
207
|
+
$qgraphflow:q-flow Analysiere die Bestellerstellung und erstelle ein chinesisches Sequenzdiagramm für Preisberechnung, Bestandsreservierung, Zahlung und Speicherung der Bestellung, einschließlich Fehlerzweigen.
|
|
170
208
|
```
|
|
171
209
|
|
|
172
210
|
Bestellerstellung und Schritte durch den tatsächlichen Projektablauf ersetzen. Im selben Gespräch weiterfragen:
|
|
173
211
|
|
|
174
212
|
```text
|
|
175
|
-
$qgraphflow:q-flow Vertiefe die Bestandsreservierung aus dem letzten Diagramm als separates
|
|
213
|
+
$qgraphflow:q-flow Vertiefe die Bestandsreservierung aus dem letzten Diagramm als separates chinesisches Flussdiagramm mit Erfolgs- und Fehlerbehandlung.
|
|
176
214
|
```
|
|
177
215
|
|
|
178
216
|
Ergebnisse landen standardmäßig unter `docs/qgraphflow/`. `index.html` zum Erkunden, Bearbeiten und Exportieren öffnen; `graph.json` enthält die Diagrammdaten. Jede Ansicht wird außerdem als SVG geschrieben (`diagram.svg`, bei mehreren Ansichten `diagram-<n>-<type>.svg`), das sich als Bild in eine README, einen Pull Request oder ein Wiki einbinden lässt.
|
|
@@ -180,26 +218,23 @@ Ergebnisse landen standardmäßig unter `docs/qgraphflow/`. `index.html` zum Erk
|
|
|
180
218
|
Nach Änderungen auf der Seite schreibt **Mehr → Änderungen speichern** in Chrome oder Edge Seite, `graph.json` und SVGs direkt zurück, sobald der Diagrammordner einmal gewählt ist. Andere Browser speichern nur `graph.json`: die Datei in den Ordner legen und Seite und SVGs mit `npx -y qgraphflow generate docs/qgraphflow/<name>/graph.json docs/qgraphflow/<name> --layout preserve --force` neu erzeugen.
|
|
181
219
|
|
|
182
220
|
<details>
|
|
183
|
-
<summary>Das
|
|
221
|
+
<summary>Das Jeepay-Quellcodebeispiel mit elf Ansichten ausführen</summary>
|
|
184
222
|
|
|
185
|
-
|
|
223
|
+
Wähle deine lokale Jeepay-Quellcodekopie, um die Belege zu prüfen:
|
|
186
224
|
|
|
187
225
|
```bash
|
|
188
|
-
|
|
189
|
-
|
|
190
|
-
node skills/q-flow/scripts/
|
|
191
|
-
node skills/q-flow/scripts/generate-viewer.mjs examples/showcase/ecommerce.de.graph.json output/ecommerce-de
|
|
226
|
+
export JEEPAY_REPO_ROOT="<local Jeepay repository root>"
|
|
227
|
+
node skills/q-flow/scripts/validate-graph.mjs examples/jeepay/collection.graph.json --input-only --repo-root "$JEEPAY_REPO_ROOT"
|
|
228
|
+
node skills/q-flow/scripts/generate-viewer.mjs examples/jeepay/collection.graph.json output/jeepay --repo-root "$JEEPAY_REPO_ROOT"
|
|
192
229
|
```
|
|
193
230
|
|
|
194
|
-
`output/
|
|
195
|
-
|
|
196
|
-
Der vorgebaute Viewer benötigt weder zusätzliche Abhängigkeiten noch API-Schlüssel oder Backend. Die KI-gestützte Belegsuche und Diagrammerstellung verwenden den Modelldienst des gewählten Clients.
|
|
231
|
+
Öffne `output/jeepay/index.html`; die elf SVGs liegen im selben Verzeichnis. Die Quellcoderevision und das Aktualisierungsverfahren stehen in der [Korpus-README](../../examples/jeepay).
|
|
197
232
|
|
|
198
233
|
</details>
|
|
199
234
|
|
|
200
235
|
## Diagramme mit dem Code synchron halten
|
|
201
236
|
|
|
202
|
-
Ein mit Repository-Wurzel erzeugtes Diagramm hält fest, wo jede Komponente definiert ist. Die Prüfung mit `--repo-root` schlägt fehl, wenn eine erfasste Datei fehlt, ein Zeilenbereich nicht mehr in die Datei passt oder ein erfasstes Symbol seine Zeilen verlassen hat; die Meldung nennt die Zeilen, in denen das Symbol jetzt steht. Diesen Job in die CI aufnehmen; er braucht keinen Build, keine Anmeldung und kein Token:
|
|
237
|
+
Ein mit Repository-Wurzel erzeugtes Diagramm hält fest, wo jede Komponente definiert ist, und die Zeile hinter jeder durch Code gestützten Beziehung (ein Aufruf, ein Fremdschlüssel). Die Prüfung mit `--repo-root` schlägt fehl, wenn eine erfasste Datei fehlt, ein Zeilenbereich nicht mehr in die Datei passt oder ein erfasstes Symbol seine Zeilen verlassen hat; die Meldung nennt die Zeilen, in denen das Symbol jetzt steht. Diesen Job in die CI aufnehmen; er braucht keinen Build, keine Anmeldung und kein Token:
|
|
203
238
|
|
|
204
239
|
```yaml
|
|
205
240
|
name: Diagrams
|
|
@@ -227,19 +262,21 @@ $qgraphflow:q-flow Laut CI ist docs/qgraphflow/order-sequence veraltet. Bitte ak
|
|
|
227
262
|
|
|
228
263
|
Der Skill verschiebt Anker, deren Symbol er genau einmal in der Datei findet, korrigiert nur die weiterhin gemeldeten Anker und erzeugt Seite und SVGs neu, wobei bearbeitete Positionen und Texte erhalten bleiben. Er zeichnet das Diagramm nicht neu.
|
|
229
264
|
|
|
230
|
-
## Welche Fragen die
|
|
265
|
+
## Welche Fragen die elf Diagrammarten beantworten
|
|
231
266
|
|
|
232
267
|
| Ansicht · PNG | Hauptfrage | Umfang des Beispiels |
|
|
233
268
|
| --- | --- | --- |
|
|
234
|
-
|
|
|
235
|
-
|
|
|
236
|
-
|
|
|
237
|
-
|
|
|
238
|
-
|
|
|
239
|
-
|
|
|
240
|
-
|
|
|
241
|
-
|
|
|
242
|
-
|
|
|
269
|
+
| Plattformfähigkeitsarchitektur | Welche Fähigkeiten bietet die Plattform? | Fähigkeitsbereiche und Matrizen |
|
|
270
|
+
| Architektur der Engineering-Schichten | Wie ist der Projektcode organisiert? | Engineering-Schichten und gemeinsame Unterstützung |
|
|
271
|
+
| Komponentenbeziehungsarchitektur | Welche Verantwortungsgrenzen arbeiten im System zusammen? | Kanäle, Transaktionsorchestrierung, Preise, Risiko, Bestand, Zahlung, Bestellungen, Ereignisse und Auftragsabwicklung |
|
|
272
|
+
| Flussdiagramm | Wie verzweigt und vereinigt sich jeder Entscheidungspunkt? | Fehlbestand, Risikoablehnung, Kompensation bei Zahlungsfehlern und erfolgreicher Commit |
|
|
273
|
+
| Sequenz | In welcher Reihenfolge führt eine Anfrage Aufrufe aus und erhält Rückgaben? | Hauptpfad eines erfolgreichen Kaufabschlusses und asynchrones OrderPaid |
|
|
274
|
+
| ER | Wie hängen die Kerndaten zusammen? | Warenkorb, Bestellungen, Positionen, Zahlungen, Bestandsreservierungen und Pakete |
|
|
275
|
+
| Bereitstellung | Wo werden Laufzeiteinheiten platziert und wie sind sie verbunden? | Randnetz, Kubernetes, Datendienste, Zahlung und Lager-/Logistiknetze |
|
|
276
|
+
| Klasse | Wie hängen Domänenobjekte und Codeverträge voneinander ab? | Checkout-Anwendungsdienst, Order und vier Ports |
|
|
277
|
+
| Zustand | Welche Ereignisse und Wächterbedingungen treiben eine Bestellung voran? | Zahlung, Auftragsabwicklung, Stornierung, Erstattung und Abschluss |
|
|
278
|
+
| Anwendungsfall | Welche Fähigkeiten besitzt jeder Akteur? | Käufer, Händler, Lager und Kundendienst |
|
|
279
|
+
| Datenfluss | Welche Transformationen und Speicher durchlaufen Datenbestände? | Warenkorb, Transaktionsentscheidungen, Bestellereignisse, Lager/Logistik und Lieferbelege |
|
|
243
280
|
|
|
244
281
|
Dies ist ein Konzeptmodell zur Demonstration von QGraphFlow, kein konkretes E-Commerce-Repository. Die Beispieldatei `graph.json` erfindet keine Quellpfade und kennzeichnet Beziehungen mit `inference`. Echte Projektdiagramme benötigen nachvollziehbaren Quellcode, DDL, Konfiguration, Tests und akzeptierte Anforderungen.
|
|
245
282
|
|
|
@@ -253,10 +290,22 @@ node --test tests/*.test.mjs skills/q-flow/scripts/*.test.mjs
|
|
|
253
290
|
|
|
254
291
|
Erforderlich sind Node.js 22 oder neuer, npm, tar, zip und unzip. Fehlerberichte sollten ein minimales anonymisiertes Diagramm, Client- und Browserversion sowie Reproduktionsschritte enthalten.
|
|
255
292
|
|
|
256
|
-
Referenzdokumentation (Englisch): [Belegquellen](../../skills/q-flow/references/evidence-sources.md) · [Diagrammformat](../../skills/q-flow/references/graph-schema.md) · [Geführte Bedarfsklärung](../../skills/q-flow/references/guided-intake.md) · [Viewer-Entwicklung](../../skills/q-flow/references/viewer-development.md) · [Diagrammgestaltung](../../skills/q-flow/references/visual-contract.md)
|
|
293
|
+
Referenzdokumentation (Englisch): [Belegquellen](../../skills/q-flow/references/evidence-sources.md) · [Diagrammformat](../../skills/q-flow/references/graph-schema.md) · [Geführte Bedarfsklärung](../../skills/q-flow/references/guided-intake.md) · [Viewer-Entwicklung und Abnahme](../../skills/q-flow/references/viewer-development.md) · [Diagrammgestaltung](../../skills/q-flow/references/visual-contract.md)
|
|
257
294
|
|
|
258
295
|
## Lizenz und Zuordnung
|
|
259
296
|
|
|
260
297
|
[MIT](../../LICENSE) · [Drittanbieterhinweise](../../THIRD_PARTY_NOTICES.md)
|
|
261
298
|
|
|
262
|
-
QGraphFlow ist ein unabhängiges Projekt unter MIT-Lizenz. Die Szenarien in diesem Dokument sind
|
|
299
|
+
QGraphFlow ist ein unabhängiges Projekt unter MIT-Lizenz. Die Szenarien in diesem Dokument sind konzeptionelle Beispiele und stellen keine Produktionsarchitektur eines realen Unternehmens dar.
|
|
300
|
+
|
|
301
|
+
## Architekturübersichten
|
|
302
|
+
|
|
303
|
+
Architektur umfasst jetzt Komponentenbeziehungen, Plattformfähigkeiten und Engineering-Schichten. Beschreibe den Gegenstand und die Frage; der Skill wählt die Vorlage. Angeforderte Sammlungen können mehrere Architekturansichten mit unabhängigen Bearbeitungen enthalten.
|
|
304
|
+
|
|
305
|
+
```text
|
|
306
|
+
$qgraphflow:q-flow Analysiere die Plattformfähigkeiten und die geschäftlichen Integrationswege des aktuellen Projekts und erzeuge eine Übersicht der Plattformfähigkeiten auf Chinesisch.
|
|
307
|
+
$qgraphflow:q-flow Analysiere die Organisation des aktuellen Projekts und seine Komponentenschichten und erzeuge chinesische Übersichten des Gesamtprojekts und eines Komponentenquerschnitts.
|
|
308
|
+
$qgraphflow:q-flow Erzeuge eine englische Übersicht der Plattformfähigkeiten dieses Projekts und zeige, wie sich Anwendungsmodule integrieren.
|
|
309
|
+
```
|
|
310
|
+
|
|
311
|
+
Siehe [examples/jeepay](../../examples/jeepay) für quellenbasierte Architekturansichten zu Plattform, Engineering und Komponentenbeziehungen. Entsperre eine Übersicht, um Karten innerhalb einer Schicht neu anzuordnen oder Texte zu bearbeiten. Speichern erhält alle Ansichten; Zurücksetzen stellt nur die aktuelle wieder her.
|