Dokumentationskarte

Die nächste hilfreiche Antwort finden.

Dieser Leitfaden erklärt das Produktmodell. Die verlinkte Projektdokumentation ist die vollständige, verbindliche Referenz für Schreiben, Profile, Themes, Befehle und Entwicklung.

Befehlsübersicht

Den Compiler fragen, nicht eine alte Vorlage.

Diese Befehle bilden die tägliche Oberfläche. Verwenden Sie denjenigen, der die tatsächliche Frage beantwortet.

Ich möchte…BefehlErgebnis
Dokumenttypen sehendocc typesBekannte Typen mit Beschreibung und Theme.
Anforderungen eines Typs verstehendocc describe ch_letterDen ganzen Vertrag: Frontmatter, Struktur, Semantik, Leerfelder und Regeln.
Eine gültige Quelldatei startendocc example ch_letter > brief.mdEin kompaktes, vom Schema gepflegtes Beispiel.
Alle Probleme vor Ausgabe sehendocc check brief.mdGesammelte Diagnosen mit Position und Hinweis.
Das Word-Dokument erstellendocc build brief.mdPrüfung vor Ausgabe, dann .docx neben der Quelle.
Geparsten Inhalt als Daten lesendocc read brief.mdFrontmatter, Text, Spans und Felder als JSON.
Die wirksame Konfiguration sehendocc doctorAufgelöste Schemas, Themes und Profilquelle.
Editor-Diagnosen erhaltendocc lspLanguage Server über Standard-Ein- und Ausgabe.
Für Tools und CI: Bei unterstützten Befehlen --json verwenden. Erfolgreiche Resultate bleiben auf stdout strukturiert; Build-Diagnosen sind separates JSON auf stderr.
Der tägliche Ablauf

Eine Quelle, eine Rückmeldeschleife.

Entdecken. Mit types, describe und example wird der Vertrag sichtbar, bevor das Schreiben beginnt.

Verfassen. Markdown und Frontmatter bearbeiten; Tatsachen als Daten, Aussagen als Prosa behalten.

Prüfen. docc check während des Schreibens ausführen oder dieselben Diagnosen im Editor anzeigen lassen.

Erstellen. Nur bestandene Quellen rendern. Das Profil liefert das feste Erscheinungsbild; der Compiler den Nachweis für erfüllte Anforderungen.

Inputs prüfen. Änderungen an Quelle, Schema, Theme oder Lockdatei sind echte Dokumentänderungen. Builds bleiben deterministisch.

# Ein expliziter CI-Check.
docc check --strict docs/*.md

# Maschinenlesbare Variante.
docc check --json docs/*.md
Verbindliche Projektdokumentation

Nach der konkreten Frage vertiefen.

Sinnvoller Diagnosepfad

Wenn ein Dokument nicht baut, bei der Quellzeile anfangen.

Fehlercode, Caret und Hinweis lesen. Zuerst die verfasste Datei korrigieren. Bei einer Typanforderung docc describe <type> nutzen; bei Unsicherheit über Profil oder Theme docc doctor oder docc profile status.

docc check brief.md
# Tatsachen oder Struktur aus der Diagnose korrigieren.

docc describe ch_letter
# Dokumentvertrag erneut ansehen.

docc doctor
# Auswahl von Schema und Theme prüfen.
Die generierte Word-Datei nicht als Primärquelle flicken. Nur die Markdown-Quelle lässt sich wieder prüfen und zuverlässig neu bauen.