torben
18ae28f918
Chemenu kompiliert Rohnotizen zu einem verlinkten, quellengebundenen Wiki: raw/ -> types/ + tools/ -> kb/ -> reports/. Was mechanisch ist, macht tools/wikitool; was Urteil braucht, macht ein Agent unter Contracts, deren Grenzen in Code durchgesetzt sind statt im Prompt. Dieser Commit ist der Startpunkt der oeffentlichen Historie. Die vorherige Entwicklung fand in einer privaten Instanz statt und ist nicht Teil dieses Repositorys; ihre Erzaehlung steht vollstaendig in CHANGES.md, das mit 44 Eintraegen von 0.1.0 bis 2.1.0 erhalten geblieben ist. Der mitgelieferte Korpus ist ein Testbett und eine Demo: 170 Seiten ueber den Stack selbst - Gates, Lint, Versionierung, Suche, das Wiki-Muster. Er dokumentiert das Werkzeug mit den eigenen Mitteln des Werkzeugs. Lizenz: AGPL-3.0 fuer den Stack (tools/, types/), CC-BY-4.0 fuer die Inhalte. Die Grenze zwischen beiden ist der Dateiplan, den dist export berechnet - siehe NOTICE.
3.0 KiB
3.0 KiB
type, name, description, schema, base_dir, page_ref_fields
| type | name | description | schema | base_dir | page_ref_fields | |
|---|---|---|---|---|---|---|
| types/type-spec.md | comparison | Strukturierter Typ für Vergleichsseiten, die mehrere Entities oder Ansätze gegenüberstellen | types/comparison.schema.yaml | comparisons |
|
Comparison
comparison ist der Typ für Seiten, die mehrere Entities, Werkzeuge, Technologien oder Ansätze systematisch anhand festgelegter Kriterien gegenüberstellen. Vergleichsseiten stützen Entscheidungen und machen Zielkonflikte zwischen Alternativen sichtbar.
Wann zu verwenden
- Vergleich mehrerer Technologien oder Frameworks für einen konkreten Einsatzzweck
- Analyse der Vor- und Nachteile verschiedener Werkzeuge oder Bibliotheken
- Bewertung alternativer Lösungswege für ein Problem
- Dokumentation eines Entscheidungsprozesses mit mehreren geprüften Optionen
Wann NICHT zu verwenden
- Für die Dokumentation einer einzelnen Entity oder eines Concepts (dann
entitybzw.concept) - Für Zusammenfassungen von Quellmaterial (dann
source) - Für Seiten, die einen einzelnen Gegenstand behandeln statt mehrere zu vergleichen
Frontmatter
| Feld | Pflicht | Verwendung |
|---|---|---|
type |
Ja | types/comparison.md |
tags |
Nein | Navigations-Tags zur Kategorisierung |
created |
Ja | Erstellungsdatum (YYYY-MM-DD) |
entities |
Ja | Titel der verglichenen Entities |
summary |
Ja | Einzeiler für kb/index.md |
Autorenanweisungen
- Ein Titel, der den Vergleich benennt (z. B. "Go vs Rust", "Kubernetes vs Docker Swarm"); er folgt den etablierten Namen der verglichenen Gegenstände, nicht der KB-Sprache (
kb/CONTRACT.md, Abschnitte "Naming" und "Language") - Klar darlegen, was verglichen wird und warum
- Eine Vergleichstabelle mit den Kriterien als Zeilen verwenden
- Eine Analyse, die die Tabelle auswertet statt sie zu wiederholen
- Eine Empfehlung, wo eine begründbar ist
Template
# Comparison: {name}
## Überblick
TODO: Kurzer Überblick, was verglichen wird und warum der Vergleich zählt.
## Vergleichstabelle
| Kriterium | {entities|table_header} |
|-----------|{entities|table_sep}|
| TODO | {entities|table_cells} |
## Analyse
TODO: Auswertung des Vergleichs. Welche Muster zeigen sich? Was sind die entscheidenden Unterschiede?
## Empfehlung
TODO: Falls möglich - was wann und für wen zu verwenden ist. Unter welchen Umständen ist welche Option die beste?
# Comparison: bleibt als Präfix stehen - anders als bei source ist es kein title_prefix,
sondern reine Template-Konvention, und der Seitentitel selbst (Go vs Rust) trägt es nicht.
Fügt wikitool xref eine Beziehung hinzu, entsteht ## Siehe auch; der Name steht in
tools/chemenu/sections.py.
Ergänzende Hinweise:
- Vergleichsseiten stützen Technologieauswahl und Architekturentscheidungen
- Die verglichenen Entities sollten alle als Wiki-Seiten existieren
- Die Kriterien sollten zur anstehenden Entscheidung passen
- Ein Vergleich bleibt auf einen konkreten Einsatzzweck oder Entscheidungskontext fokussiert