Strukturierte Dokumente, kompiliert

Den Inhalt schreiben.
Den Rest prüfen.

docc ist ein deterministischer Compiler für strukturierte Markdown-Dokumente. Er prüft, was ein Dokument enthalten muss, bevor er die Word-Datei erstellt, mit der Menschen tatsächlich arbeiten.

Einen geprüften Brief erstellenMarkdown rein · Vertrag geprüft · .docx raus
~/akten · zsh
$ docc check mahnung.md
prüfe ch_letter gegen starter-letter…
✓ Struktur entspricht dem Dokumenttyp
✓ Pflichtwerte erfüllen das Schema
✓ Briefregeln erfüllt

$ docc build mahnung.md
validiere vor dem Rendern…
✓ mahnung.docx
Weshalb ein Compiler?

Eine Datei, die sich öffnen lässt, ist noch kein Dokument, dem man vertrauen kann.

Word rendert fast alles. Ein Dokument-Compiler macht Anforderungen ausdrücklich, prüft sie in einem Durchlauf und verweigert die Ausgabe, wenn der Dokumentvertrag verletzt ist.

01 / VERFASSEN

Die Quelle lesbar halten

Markdown bleibt Text: Absätze, Überschriften und Listen; YAML enthält die Tatsachen eines Briefs.

02 / PRÜFEN

Anforderungen ausführbar machen

Ein Schema beschreibt Felder, Struktur und Regeln. docc zeigt jeden Fehler an der Quellstelle mit Hinweis.

03 / ERSTELLEN

Layout aus dem Text heraushalten

Ein Theme besitzt Briefkopf, Stile und Seitenelemente. Gültiger Text wird damit reproduzierbar zu .docx.

Das ganze System

Eine kleine Pipeline. Eine klare Verantwortung pro Schritt.

01 / QUELLEMarkdownLesbarer Text und Frontmatter in einer diffbaren Datei.
02 / PARSENStrukturÜberschriften, Blöcke, Spans und Felder werden als Dokumentteile verstanden.
03 / PRÜFENSchemaPflichtangaben, Reihenfolge und besondere Regeln werden zusammen geprüft.
04 / AUSGEBENTheme → .docxValidierter Inhalt trifft auf festgelegtes Layout und wiederholbare Ausgabe.
Die wichtige Grenze: docc erfindet keine Inhalte, verwaltet keinen Vorlageneditor und versteckt keinen Text in einer Datenbank. Es kompiliert ein verfasstes Dokument und macht die Validierung zur Voraussetzung der Ausgabe.
Leitfaden für die Arbeit

Mit einem Brief beginnen. Das System verstehen, wenn es nötig wird.

Das praktische Ergebnis

Die letzten fünf Minuten dem Brief widmen—nicht der Vermeidung von Dokumentpannen.

Den vorhandenen Editor benutzen. Der Compiler prüft, was ein professionelles Dokument nicht dem Gedächtnis überlassen darf.

✓der Dokumenttyp ist ausdrücklich gewählt
✓Pflichtangaben sind vorhanden und korrekt formatiert
✓das Layout kommt aus dem freigegebenen Profil

Zur Brief-Anleitung