Skip to content

08 Quick Start

Jump to bottom
Asterios Raptis edited this page Mar 11, 2026 · 5 revisions

Quick Start: Integration in Buchprojekte

Diese Anleitung zeigt, wie du manuscript-tools in ein bestehendes Buchprojekt integrierst.

Voraussetzungen

  • Ein Buchprojekt mit Poetry
  • Markdown-Manuskript unter manuscript/ (oder aehnlich)

Schritt 1: Dependency hinzufuegen

poetry add manuscript-tools

Damit stehen die CLI-Kommandos ms-check, ms-sanitize, ms-metrics und ms-validate in der Poetry-Shell bereit.

Schritt 2: Schnelltest

# Einzelnes Kapitel pruefen
poetry run ms-check manuscript/chapters/06-chapter.md

# Ganzes Manuskript, alle Regeln
poetry run ms-check manuscript/ --strict

# Lesbarkeit
poetry run ms-metrics manuscript/

# Volle Pipeline
poetry run ms-validate manuscript/

Schritt 3: Makefile-Targets ergaenzen

Die meisten Buchprojekte haben bereits ein Makefile mit Targets wie lint, test, export. Um Kollisionen zu vermeiden, nutzen die manuscript-tools Targets das Praefix ms-.

Fuege folgenden Block in dein bestehendes Makefile ein:

# ----------------------------------------------------------------------
# Manuscript Tools
# ----------------------------------------------------------------------

MANUSCRIPT ?= manuscript

.PHONY: ms-check ms-check-strict ms-sanitize ms-sanitize-dry ms-quotes ms-quotes-dry ms-format ms-format-dry ms-metrics ms-validate ms-validate-fix

ms-check: ## Manuscript: core style checks
	@$(POETRY) run ms-check $(MANUSCRIPT)

ms-check-strict: ## Manuscript: all checks (filler, passive, sentence length)
	@$(POETRY) run ms-check $(MANUSCRIPT) --strict

ms-sanitize: ## Manuscript: sanitize with backup
	@$(POETRY) run ms-sanitize $(MANUSCRIPT) --backup

ms-sanitize-dry: ## Manuscript: preview sanitization
	@$(POETRY) run ms-sanitize $(MANUSCRIPT) --dry-run

ms-quotes: ## Manuscript: fix German quotation marks
	@$(POETRY) run ms-quotes $(MANUSCRIPT)

ms-quotes-dry: ## Manuscript: preview quotation mark fixes
	@$(POETRY) run ms-quotes $(MANUSCRIPT) --dry-run

ms-format: ## Manuscript: fix broken bold/italic formatting
	@$(POETRY) run ms-format $(MANUSCRIPT)

ms-format-dry: ## Manuscript: preview formatting fixes
	@$(POETRY) run ms-format $(MANUSCRIPT) --dry-run

ms-metrics: ## Manuscript: word counts and readability
	@$(POETRY) run ms-metrics $(MANUSCRIPT)

ms-validate: ## Manuscript: full pipeline (sanitize + check + readability)
	@$(POETRY) run ms-validate $(MANUSCRIPT)

ms-validate-fix: ## Manuscript: full pipeline with auto-fix
	@$(POETRY) run ms-validate $(MANUSCRIPT) --fix

Danach:

make ms-validate
make ms-check-strict
make ms-metrics

Der MANUSCRIPT-Pfad ist ueber die Variable ueberschreibbar:

make ms-validate MANUSCRIPT=manuscript/chapters
make ms-check MANUSCRIPT=manuscript/chapters/06-chapter.md

Empfohlener Workflow

Waehrend des Schreibens

# Schneller Check eines Kapitels
make ms-check MANUSCRIPT=manuscript/chapters/06-chapter.md

# Lesbarkeit pruefen
make ms-metrics MANUSCRIPT=manuscript/chapters/06-chapter.md

Nach dem Schreiben

# Gruendliche Pruefung mit Prosa-Regeln
make ms-check-strict MANUSCRIPT=manuscript/chapters/06-chapter.md

# Encoding-Probleme pruefen
make ms-sanitize-dry MANUSCRIPT=manuscript/chapters/06-chapter.md

Vor dem Commit

# Ganzes Manuskript validieren
make ms-validate

Vor dem Export/Publish

# Validieren und bereinigen
make ms-validate-fix

Optional: Pre-Commit-Hook

Fuege in .githooks/pre-commit oder .pre-commit-config.yaml hinzu:

#!/usr/bin/env bash
poetry run ms-check manuscript/

Damit kommen Gedankenstriche, doppelte Woerter und unsichtbare Zeichen gar nicht erst ins Repository.

Verfuegbare Regeln

Core (immer aktiv)

Regel Prueft auf
no-dashes En-Dashes und Em-Dashes
no-invisible-chars Zero-Width-Spaces, BOM, Bidi
no-repeated-words "der der", "und und"
no-double-spaces Mehrfache Leerzeichen
non-german-quotes Nicht-deutsche Anführungszeichen
broken-formatting Gebrochene Bold/Italic-Marker

Prosa (mit --strict oder ms-validate)

Regel Prueft auf
max-sentence-length Saetze ueber 40 Woerter
filler-words-de eigentlich, irgendwie, quasi, halt, ...
passive-voice-de wird gelesen, wurde gebaut, ist versandt worden

Lesbarkeit

Metrik Beschreibung
Flesch-DE Lesbarkeitsindex 0-100 (hoeher = leichter)
Satzlaenge Durchschnittliche Woerter pro Satz
Silben/Wort Durchschnittliche Silben pro Wort

Richtwerte fuer Flesch-DE nach Genre:

  • Kinderbuch: 80+
  • Unterhaltungsroman: 65-80
  • Sachbuch: 50-65
  • Fachbuch: 30-50

Optional: Projekt-Konfiguration

Regeln und Schwellenwerte lassen sich pro Buchprojekt in der pyproject.toml anpassen:

[tool.manuscript-tools]
rules = ["max-sentence-length"]
disable = ["passive-voice-de"]
max-sentence-words = 30
flesch-target = [65, 80]
filler-words-extra = ["definitiv", "absolut"]

Ohne Konfiguration greifen die Defaults. Details: Konfiguration.

Zurück: FAQ | Weiter: Konfiguration

Clone this wiki locally