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
4.0 KiB
4.0 KiB
type, name, description, schema, subtype_field, base_dir, page_ref_fields, layout
| type | name | description | schema | subtype_field | base_dir | page_ref_fields | layout | ||||||||||||||||||||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
| types/type-spec.md | entity | Basistyp für Entity-Seiten - Projekte, Systeme, Werkzeuge, Technologien oder Personen | types/entity.schema.yaml | entity_type | entities |
|
|
Entity
entity ist der Typ für konkrete Dinge: Projekte, Systeme, Werkzeuge, Technologien oder Personen. Entities sind die primären Bausteine des Wissensgraphen.
Wann zu verwenden
- Darstellung eines Softwareprojekts, einer Initiative oder eines Arbeitsvorhabens
- Dokumentation eines betriebenen Systems, Dienstes oder einer Infrastrukturkomponente
- Beschreibung eines CLI-Werkzeugs, Hilfsprogramms oder einer Programmbibliothek
- Festhalten von Informationen zu einer Sprache, einem Framework oder einem Protokoll
- Dokumentation einer Person, eines Teams oder einer Organisation
Wann NICHT zu verwenden
- Für abstrakte Konzepte, Muster oder Methodiken (dann
concept) - Für Quelldokumente oder eingelesenes Material (dann
source) - Für vergleichende Analysen (dann
comparison)
Frontmatter
| Feld | Pflicht | Verwendung |
|---|---|---|
type |
Ja | types/entity.md |
entity_type |
Ja | Eines von: project, system, tool, technology, person |
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 Seiten (Entities, Concepts, Sources) |
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 der Entity und folgt der etablierten Bezeichnung des Gegenstands, nicht der KB-Sprache (
kb/CONTRACT.md§ "Titles are identifiers",kb/CONVENTIONS.md§§ "Naming" und "Language") - Die Hauptbeschreibung steht weit oben
- Auf verwandte Entities und Concepts verlinken, wo Beziehungen bestehen
- 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:** {entity_type|capitalize}
## Beschreibung
TODO: 1-2 Absätze dazu, was diese Entity ist und wozu sie dient.
## Kerndaten
- **Zweck:** TODO
- **Status:** aktiv, abgelöst, in Planung usw.
- **Version:** TODO (falls zutreffend)
- **Sprache/Technik:** TODO (falls zutreffend)
- **Verantwortlich:** TODO (falls zutreffend)
- **Repository:** TODO (falls zutreffend)
## {section.relationships}
- **Hängt ab von:** TODO
- **Verwendet von:** TODO
- **Verwandt mit:** TODO
## Details
TODO: Ausführliche Informationen, nach sinnvollen Abschnitten gegliedert
## Historie
- [{today}] - Page created via wikitool
## {section.see_also}
- TODO: Verwandte Seiten
Die beiden {section.…}-Platzhalter sind toolgeführte Abschnitte: wikitool xref schreibt in
genau sie hinein, und wie sie heißen, entscheidet die Instanz in kb/CONVENTIONS.md
(sections:) - nicht dieser Type-Spec und nicht der Compiler. wikitool new setzt den
aktuellen Namen ein. Der Wert hinter **Typ:** bleibt der englische Enum-Wert - danach filtert
search --field.
Ergänzende Hinweise:
- Entity-Seiten bilden den konkreten Bestand der Wissensbasis
- Jeder Entity-Typ (project, system, tool usw.) ist eine Ausprägung dieses Basistyps
- Die Beziehungen zwischen Entities tragen die Vernetzung des Wissensgraphen