502971d147
Files changed: - .gitea/workflows/ci.yml - .wikitool-kb.json - AGENTS.md - CHANGES.md - INSTALL.md - README.md - VERSION - instructions/CONTRACT.md - instructions/dev/testing-conventions.md - instructions/german-terminology.md - instructions/kb-profiles.md - instructions/migrations/3.0.0-authoring-conventions.md - instructions/private-instance.md - instructions/setup-instance.md - instructions/wiki-ingest/SKILL.md - instructions/wiki-manage/SKILL.md - kb/CONTRACT.md - kb/CONVENTIONS.md - kb/CONVENTIONS.md.template - kb/comparisons/COLLECTION.md - kb/concepts/COLLECTION.md - kb/entities/COLLECTION.md - kb/sources/COLLECTION.md - tools/CONTRACT.md - tools/README.md - tools/chemenu/commands/dist_cmd.py - tools/chemenu/commands/docs_verify.py - tools/chemenu/commands/doctor.py - tools/chemenu/commands/new_page.py - tools/chemenu/conventions.py - tools/chemenu/kb_collections.py - tools/chemenu/kb_scan.py - tools/chemenu/provenance.py - tools/chemenu/sections.py - tools/chemenu/tests/conftest.py - tools/chemenu/tests/test_conventions.py - tools/chemenu/tests/test_dist_cmd.py - tools/chemenu/tests/test_doctor.py - tools/chemenu/tests/test_new_page.py - tools/chemenu/tests/test_types_cmd.py - types/comparison.md - types/concept.md - types/entity.md - types/source.md - types/type-spec.md
3.8 KiB
3.8 KiB
type, name, description, schema, subtype_field, base_dir, page_ref_fields
| type | name | description | schema | subtype_field | base_dir | page_ref_fields | ||
|---|---|---|---|---|---|---|---|---|
| types/type-spec.md | concept | Basistyp für Concept-Seiten - Architekturen, Muster, Protokolle, Abläufe, Entscheidungen oder Problemstellungen | types/concept.schema.yaml | concept_type | concepts |
|
Concept
concept ist der Typ für abstrakte Ideen, Methodiken, Muster und Architekturentscheidungen. Concepts liefern die theoretische und methodische Grundlage, die Entities umsetzen oder befolgen.
Wann zu verwenden
- Dokumentation eines Architekturmusters oder Entwurfsansatzes
- Erläuterung eines Entwurfsmusters oder einer Programmiermethodik
- Beschreibung eines Kommunikationsprotokolls oder Standards
- Festhalten eines Ablaufs oder Prozesses, der über Projekte hinweg wiederkehrt
- Dokumentation einer Architekturentscheidung (ADR) oder Entwurfsentscheidung
- Analyse eines wiederkehrenden Problems und seiner Lösungen
Wann NICHT zu verwenden
- Für konkrete Dinge wie Projekte, Systeme oder Werkzeuge (dann
entity) - Für Quelldokumente oder eingelesenes Material (dann
source) - Für vergleichende Analysen konkreter Gegenstände (dann
comparison)
Frontmatter
| Feld | Pflicht | Verwendung |
|---|---|---|
type |
Ja | types/concept.md |
concept_type |
Ja | Eines von: architecture, pattern, protocol, workflow, decision, problem |
tags |
Nein | Navigations-Tags zur Kategorisierung |
created |
Ja | Erstellungsdatum (YYYY-MM-DD) |
modified |
Ja | Datum der letzten Änderung (YYYY-MM-DD) |
related |
Nein | Titel verwandter Concepts und Entities |
sources |
Nein | Titel der Source-Seiten, die die Aussagen dieser Seite stützen |
confidence |
Nein | Abgeleitete Konfidenz (0.0-1.0), neu berechnet von wikitool confidence decay |
confidence_base |
Nein | Unverfallene Konfidenz zum Zeitpunkt der letzten Bestätigung - bei einer Neubewertung dieses Feld ändern, nicht confidence |
provenance |
Ja | sourced, general oder mixed |
summary |
Ja | Einzeiler für kb/index.md |
Autorenanweisungen
- Der Titel ist der kanonische Name des Concepts und folgt der etablierten Fachbezeichnung, nicht der KB-Sprache (
kb/CONTRACT.md§ "Titles are identifiers",kb/CONVENTIONS.md§§ "Naming" und "Language") - Mit einer klaren Definition beginnen: was das Concept ist
- Beispiele geben, wo sie das Verständnis tragen
- Auf Entities verlinken, die das Concept umsetzen oder verwenden
- Bei
provenance: sourcedodermixedharte Fakten inline mit einer[^cite-id]-Fußnote belegen -tools/wikitool cite add --page "<Title>" --source "Source - X"erzeugt Id und Definition - Wikipedia-Tonfall: sachlich, neutral, keine Werbesprache
Template
# {name}
**Typ:** {concept_type|capitalize}
## Definition
TODO: Klare Definition dessen, was dieses Concept ist.
## Kernpunkte
- TODO: Kernpunkt 1
- TODO: Kernpunkt 2
- TODO: Kernpunkt 3
## Beispiele
- [[Entity 1]] - kurze Beschreibung
- [[Entity 2]] - kurze Beschreibung
## Wann zu verwenden
TODO: Bedingungen und Kontexte, in denen dieses Concept greift
## Wann NICHT zu verwenden
TODO: Anti-Muster, Warnungen oder Situationen, in denen es fehl am Platz ist
## Verwandte Concepts
- [[Related Concept 1]]
- [[Related Concept 2]]
Der Wert hinter **Typ:** bleibt der englische Enum-Wert - danach filtert search --field.
Fügt wikitool xref eine Beziehung hinzu, entstehen zusätzlich die beiden toolgeführten
Abschnitte für Beziehungen und Querverweise; wie sie heißen, entscheidet die Instanz in
kb/CONVENTIONS.md (sections:).
Ergänzende Hinweise:
- Concept-Seiten tragen den theoretischen Unterbau des Wikis
- Jeder Concept-Typ steht für eine andere Kategorie abstrakten Wissens
- Concepts sollten von den Entities aus verlinkt sein, die sie umsetzen oder verwenden