10-Minuten-Anleitung

Einen Brief erstellen, dem Sie vertrauen können.

Starten Sie mit dem eingebauten Beispiel ch_letter. Derselbe Ablauf gilt später mit eigenen Dokumenttypen und einem eigenen Profilpaket.

Vor dem Start

Installieren und dann fragen, was vorhanden ist.

docc bringt ein Starterprofil mit. Daher kann eine unkonfigurierte Installation bereits Dokumenttypen beschreiben, ein Beispiel ausgeben und es bauen.

# Das Kommando installieren.
go install github.com/kevinzehnder/docc/cmd/docc@latest

# Typen auflisten und den Briefvertrag ansehen.
docc types
docc describe ch_letter

docc describe beantwortet die Frage «Was braucht dieses Dokument?»: Frontmatter, Struktur, Blöcke, Spans, Leerfelder und Regeln stammen aus dem Schema, nicht aus einer erratenen Word-Vorlage.

Schritt 1

Mit einer lesbaren Vorlage anfangen.

Das Beispiel gehört zum Schema selbst. So bleiben Einstieg und Dokumentvertrag zusammen; docc prüft, dass das Beispiel gültig bleibt.

docc example ch_letter > mahnung.md

Öffnen Sie mahnung.md im gewohnten Editor. Die Datei hat zwei Teile:

TeilInhaltPrüfung
YAML-FrontmatterBetreff, Absender, Empfänger, Versanddatum und weitere Briefdaten.Pflichtwerte, Typen, Muster und Standardwerte.
Markdown-TextAnrede, Begründung, Begehren, Listen und Schlussformel.Dokumentstruktur und gültige Markdown-Elemente.
---
docc: 1
document_type: ch_letter
subject: Mahnung — Rechnung 2026-114
recipient:
  name: Clara Muster
  postal_code: "3000"
---

Sehr geehrte Frau Muster

Wir vertreten die Muster Handels AG in der oben genannten Angelegenheit.
Schritt 2

Das Dokument kompilieren, bevor es zu Word wird.

check parst die ganze Quelle und führt alle Validierungen aus. Es sammelt Hinweise, statt beim ersten Problem aufzuhören—so entsteht eine brauchbare Korrekturliste.

docc check mahnung.md
$ docc check mahnung.md

mahnung.md:12:16: error[DOC010]: Feld `postal_code`
hat ungültigen Wert "300"
   |
12 |   postal_code: "300"
   |                ^^^^^ vier Ziffern, in Anführungszeichen: "3000"
Build hat dieselbe Schranke: docc build validiert immer zuerst. check ist während des Schreibens, in CI und für Editor-Diagnosen nützlich, ohne eine Datei auszugeben.
Schritt 3

Nur den bestandenen Brief erstellen.

Wenn die Prüfung sauber ist, wird die Datei ausgegeben. Seitenränder, Fensteradresse, Typografie und Fusszeile stehen nicht im Brieftext: Das gewählte Theme liefert diese festen Layoutentscheide.

docc build mahnung.md
# → mahnung.docx

docc konvertiert keine Vorlage, sondern schreibt die .docx selbst. Identische Quelle, identisches Schema und identisches Theme ergeben identische Bytes.

Weiter

Nur die nächste nötige Ebene lernen.