Skip to content

Commit f96ef8f

Browse files
author
Jörg Thönnes
committed
fix: enhance Mikado Method documentation with canonical form links and consistency fixes
1 parent 9c5787f commit f96ef8f

2 files changed

Lines changed: 16 additions & 14 deletions

File tree

docs/anchors/mikado-method.adoc

Lines changed: 7 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -39,28 +39,29 @@ Key Proponents:: Ola Ellnestam, Daniel Brolund ("The Mikado Method", 2012)
3939
* Making incremental improvements without blocking the team
4040
* Brownfield development with hidden dependencies
4141

42+
[[mikado-method-recipe-canonical-form]]
4243
[discrete]
4344
== *Mikado Method Recipe (Canonical Form)*
4445

4546
1. Start here: Draw the Mikado Goal.
4647
2. Implement the goal or prerequisite naively.
4748
3. Are there any errors?
4849
* Examples: compiler errors, failing tests, runtime errors, broken builds.
49-
* If **Yes**, go to step 4.
50-
* If **No**, go to step 9.
50+
* If *Yes*, go to step 4.
51+
* If *No*, go to step 9.
5152
4. Come up with immediate solutions to the errors.
5253
5. Draw the solutions as new prerequisites in the Mikado Graph.
5354
6. Revert all changes and return to the last known good state.
5455
7. Select the next prerequisite to work with.
5556
8. Go to step 2.
5657
9. Does the change make sense?
5758
* Examples: understandable, internally consistent, safe to keep, useful on its own.
58-
* If **Yes**, go to step 10.
59-
* If **No**, go to step 7.
59+
* If *Yes*, go to step 10.
60+
* If *No*, go to step 7.
6061
10. Commit the change.
6162
11. Is the Mikado Goal met?
62-
* If **Yes**, go to step 12.
63-
* If **No**, go to step 7.
63+
* If *Yes*, go to step 12.
64+
* If *No*, go to step 7.
6465
12. DONE!
6566

6667

docs/anchors/mikado-method.de.adoc

Lines changed: 9 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -16,7 +16,7 @@ Mikado-Ziel:: Der klare, angestrebte zukünftige Zustand des Codes nach dem Refa
1616

1717
Voraussetzungsermittlung:: Blockierende Abhängigkeiten aufdecken, indem die Änderung versucht und notiert wird, was dabei bricht
1818

19-
Experimente nutzen:: Bevorzuge schnelle oder zeitlich begrenzte empirische Versuche gegenüber langen Vorabananalysen
19+
Experimente nutzen:: Bevorzuge schnelle oder zeitlich begrenzte empirische Versuche gegenüber langen Vorab-Analysen
2020

2121
Immer rückgängig machen:: *WICHTIG*: Nach dem Entdecken einer Voraussetzung *immer* zum letzten bekannten funktionierenden Zustand zurückkehren, bevor diese angegangen wird
2222

@@ -39,28 +39,29 @@ Schlüsselvertreter:: Ola Ellnestam, Daniel Brolund ("The Mikado Method", 2012)
3939
* Inkrementelle Verbesserungen vornehmen, ohne das Team zu blockieren
4040
* Brownfield-Entwicklung mit versteckten Abhängigkeiten
4141

42+
[[mikado-methode-rezept-kanonische-form]]
4243
[discrete]
43-
== *Mikado-Methode Rezept (Kanonische Form)*
44+
== *Mikado-Methode-Rezept (kanonische Form)*
4445

4546
1. Hier beginnen: Das Mikado-Ziel aufschreiben.
4647
2. Das Ziel oder die Voraussetzung naiv implementieren.
4748
3. Treten Fehler auf?
4849
* Beispiele: Compilerfehler, fehlschlagende Tests, Laufzeitfehler, kaputte Builds.
49-
* Wenn **Ja**, gehe zu Schritt 4.
50-
* Wenn **Nein**, gehe zu Schritt 9.
50+
* Wenn *Ja*, gehe zu Schritt 4.
51+
* Wenn *Nein*, gehe zu Schritt 9.
5152
4. Unmittelbare Lösungen für die Fehler finden.
5253
5. Die Lösungen als neue Voraussetzungen in den Mikado-Graphen einzeichnen.
5354
6. Alle Änderungen rückgängig machen und zum letzten bekannten guten Zustand zurückkehren.
5455
7. Die nächste zu bearbeitende Voraussetzung auswählen.
5556
8. Gehe zu Schritt 2.
5657
9. Ist die Änderung sinnvoll?
5758
* Beispiele: verständlich, intern konsistent, sicher beizubehalten, für sich allein nützlich.
58-
* Wenn **Ja**, gehe zu Schritt 10.
59-
* Wenn **Nein**, gehe zu Schritt 7.
59+
* Wenn *Ja*, gehe zu Schritt 10.
60+
* Wenn *Nein*, gehe zu Schritt 7.
6061
10. Die Änderung committen.
6162
11. Ist das Mikado-Ziel erreicht?
62-
* Wenn **Ja**, gehe zu Schritt 12.
63-
* Wenn **Nein**, gehe zu Schritt 7.
63+
* Wenn *Ja*, gehe zu Schritt 12.
64+
* Wenn *Nein*, gehe zu Schritt 7.
6465
12. FERTIG!
6566

6667

0 commit comments

Comments
 (0)