Files
chemenu/kb/CONVENTIONS.md
T
torben 0b8ca746fa
CI / verify (push) Successful in 49s
Release / release (push) Successful in 36s
docs/ als ausgelieferter Hintergrund-Ort; Decision-Seiten bleiben in kb/, Decay-Skip fuer concept_type: decision (4.3.0, #38)
Files changed:
- AGENTS.md
- CHANGES.md
- VERSION
- instructions/kb-profiles.md
- kb/CONVENTIONS.md
- kb/concepts/COLLECTION.md
- tools/CONTRACT.md
- tools/chemenu/commands/confidence_decay.py
- tools/chemenu/commands/dist_cmd.py
- tools/chemenu/tests/test_confidence_decay.py
- tools/chemenu/tests/test_dist_cmd.py
2026-09-03 19:01:21 +02:00

5.8 KiB

language, profile, sections
language profile sections
de german
links footnotes
Beziehungen Fußnoten

kb/ - Authoring Conventions of This Instance

The decisions kb/CONTRACT.md deliberately does not make. The contract holds what the code enforces and is identical in every instance; this file holds what this instance chose, and no other instance has to agree with a word of it.

It binds all the same. Everything below applies to every page under kb/, exactly as the contract does. The difference is ownership, not authority: a rule here is changed by editing this file, a rule there by changing the stack.

Adopted from the german profile in instructions/kb-profiles.md. That catalogue is a palette, not an enum - what is written here is what holds, whether or not a profile says the same thing.

The frontmatter above is the one machine-read part. sections: names the headings the two generated regions render under - the links region wikitool xref owns and the footnotes region wikitool cite owns. Each sits between a marker pair, and the marker is what the tool locates it by, so the heading here is a display value: changing it re-renders the words above those regions and nothing else. Nothing matches on this text.

Language

Pages are written in German. This binds kb/ and the authoring surface that shapes it - the page type-specs types/entity.md, types/concept.md, types/source.md and types/comparison.md. raw/ is untouched (raw/CONTRACT.md), and the control plane stays English: AGENTS.md, the stage contracts, this file, instructions/, and the type-specs for non-page artifacts.

Which line is prose and which is an identifier - and therefore what is translated at all - is the contract's rule, not this file's: see kb/CONTRACT.md § Language and identifiers.

Established English technical terms stay English inside German prose - "GitOps", "Ownership Model", "Reverse Proxy", "Pull Request". Translate a term only where the German one is genuinely the more common usage. A coined German equivalent nobody else writes makes the page harder to find, not more idiomatic.

Which terms those are, which have a settled German form, and the register the prose is written in: instructions/german-terminology.md. It is lookup material, not a second rule - every entry in it is a decision that was made wrong once first.

Section headings

The two generated regions render under ## Beziehungen and ## Fußnoten. An author never writes inside them - they are rebuilt from frontmatter on every write, exactly like kb/index.md - and never has to write the heading either. Any other heading on a page is ordinary prose and is translated with the rest.

There is no ## Siehe auch region any more. It was the reciprocal half of a bidirectional xref add; under authored directional edges, see-also is a label inside the links region.

Naming

  • Human-readable titles with spaces: Hybrid Search.md, Gitea Actions.md - not kebab-case.
  • Singular for entities: ha-core.md, not ha-cores.md.
  • Comparison pages read as a comparison: Go vs Rust.md.
  • A decision (concept_type: decision) is named like any other concept - no adr-NNN- prefix. See kb/concepts/COLLECTION.md § Decisions.
  • Prefer readability over convention when the two conflict.

What to name a thing: projects use their repository or common name; systems a descriptive name; tools the tool's own name; technologies their standard spelling and capitalization; people a full name or common handle.

The one naming fact that is not a choice, and therefore lives in the contract: the filename stem is the page title, and [[wikilinks]] must match it exactly.

Tone

Wikipedia style: factual, neutral, specific.

  • No buzzwords ("bahnbrechend", "hochmodern", "leistungsstark", "revolutioniert").
  • No AI filler ("es sei angemerkt", "es ist wichtig zu betonen", "in der heutigen Zeit").
  • No em-dash asides carrying parenthetical reasoning.

Good: "MQTT ist ein leichtgewichtiges Publish-Subscribe-Protokoll für Geräte mit knappen Ressourcen."

Bad: "MQTT ist ein bahnbrechendes, hochmodernes Protokoll, das die IoT-Kommunikation revolutioniert - und es sei angemerkt, dass es ein Publish-Subscribe-Muster verwendet."

The blockquote cap is not here: wikitool lint reports it, so it is the contract's.

Relationship labels

Not this file's to list, and not localized. A label is a machine value in related:, drawn from instructions/link-taxonomy.md and authorised per destination in each kb/<name>/COLLECTION.md's outbound: block. - **depends-on:** [[Hermes]] is what a German page carries, and that is deliberate: the label is an identifier, so translating it would make the graph's semantics depend on the prose again.

Confidence rubric

confidence_base is set by hand and confidence is derived from it - that mechanism is the contract's. What the number means is this instance's:

Base score for a single source is 0.5, adjusted by:

  • +0.2 per supporting source (max +0.6)
  • +0.2 if confirmed <30 days ago, +0.1 if <90 days
  • +0.1 for official documentation, +0.05 for a reputable secondary source
  • +0.1 if multiple independent sources agree

In prose, hedge according to the score: below 0.6 write "möglicherweise"/"kann"; below 0.4 write "unsicher"/"unbestätigt".

Keeping this file honest

Change it when a convention actually changes. sections: is safe to change at any time - the regions are located by their markers and re-rendered under the new words on the next write. wikitool doctor FAILs on a missing or unfilled file, and wikitool docs verify refuses a sections: block that does not name both regions.