Claude Code ist ein agentisches CLI-Tool, das Sie bei der Pflege Ihrer Dokumentation unterstützt. Es kann neue Inhalte verfassen, bestehende Seiten überprüfen und die Dokumentation auf dem neuesten Stand halten. Sie können Claude Code darauf trainieren, Ihre Dokumentationsstandards und Workflows zu verstehen, indem Sie Ihrem Projekt eine CLAUDE.md-Datei hinzufügen und diese im Laufe der Zeit verfeinern.

​
Erste Schritte

Voraussetzungen:
  • Aktives Claude-Abonnement (Pro, Max oder API-Zugriff)
Einrichtung:
  1. Installiere Claude Code:
  npm install -g @anthropic-ai/claude-code
  1. Navigiere zu deinem Docs-Verzeichnis.
  2. (Optional) Füge die unten stehende Datei CLAUDE.md zu deinem Projekt hinzu.
  3. Starte mit claude.

​
CLAUDE.md-Vorlage

Speichere eine CLAUDE.md-Datei im Root deines Docs-Verzeichnisses, damit Claude Code dein Projekt besser versteht. Diese Datei schult Claude Code in deinen Dokumentationsstandards, Präferenzen und Workflows. Siehe dazu Claude-Speicher verwalten in den Anthropic-Dokumenten. Kopiere diese Beispielvorlage oder passe sie an die Spezifikationen deiner Docs an: 
# Mintlify documentation

## Working relationship
- You can push back on ideas — this can lead to better documentation. Cite sources and explain your reasoning when you do so
- ALWAYS ask for clarification rather than making assumptions
- NEVER lie, guess, or make up information

## Project context
- Format: MDX files with YAML frontmatter
- Config: docs.json for navigation, theme, settings
- Components: Mintlify components

## Content strategy
- Document just enough for user success - not too much, not too little
- Prioritize accuracy and usability of information
- Make content evergreen when possible
- Search for existing information before adding new content. Avoid duplication unless it is done for a strategic reason
- Check existing patterns for consistency
- Start by making the smallest reasonable changes

## docs.json

- Refer to the [docs.json schema](https://mintlify.com/docs.json) when building the docs.json file and site navigation

## Frontmatter requirements for pages
- title: Clear, descriptive page title
- description: Concise summary for SEO/navigation

## Writing standards
- Second-person voice ("you")
- Prerequisites at start of procedural content
- Test all code examples before publishing
- Match style and formatting of existing pages
- Include both basic and advanced use cases
- Language tags on all code blocks
- Alt text on all images
- Relative paths for internal links

## Git workflow
- NEVER use --no-verify when committing
- Ask how to handle uncommitted changes before starting
- Create a new branch when no clear branch exists for changes
- Commit frequently throughout development
- NEVER skip or disable pre-commit hooks

## Do not
- Skip frontmatter on any MDX file
- Use absolute URLs for internal links
- Include untested code examples
- Make assumptions - always ask for clarification

​
Beispielprompts

Sobald Sie Claude Code eingerichtet haben, probieren Sie diese Prompts aus, um zu sehen, wie sie bei typischen Aufgaben in der Dokumentation helfen. Sie können diese Beispiele direkt kopieren und einfügen oder für Ihre spezifischen Anforderungen anpassen.

​
Notizen in ausgereifte Dokumentation umwandeln

Verwandeln Sie Rohentwürfe in korrekt formatierte Markdown-Seiten mit Komponenten und Frontmatter. Beispiel-Prompt: 
Convert this text into a properly formatted MDX page: [paste your text here]

​
Dokumentation auf Konsistenz prüfen

Erhalten Sie Vorschläge zur Verbesserung von Stil, Formatierung und der Verwendung von Komponenten. Beispielprompt: 
Review the files in docs/ and suggest improvements for consistency and clarity

​
Aktualisiere die Doku, wenn sich Funktionen ändern

Halte die Dokumentation aktuell, wenn sich dein Produkt weiterentwickelt. Beispielprompt: 
Unsere API erfordert jetzt einen Versionsparameter. Aktualisiere unsere Doku, sodass in allen Beispielen version=2024-01 enthalten ist.

​
Umfassende Codebeispiele generieren

Erstellen Sie Beispiele in mehreren Sprachen mit Fehlerbehandlung. Beispiel-Prompt: 
Create code examples for [your API endpoint] in JavaScript, Python, and cURL with error handling

​
Claude Code erweitern

Über das manuelle Prompten von Claude Code hinaus können Sie es in Ihre bestehenden Workflows integrieren.

​
Automatisierung mit GitHub Actions

Führen Sie Claude Code automatisch aus, sobald sich der Code ändert, um die Dokumentation aktuell zu halten. Sie können Dokumentations-Reviews bei Pull Requests auslösen oder Beispiele aktualisieren, wenn API-Änderungen erkannt werden.

​
Workflows mit mehreren Instanzen

Verwenden Sie separate Claude-Code-Sitzungen für unterschiedliche Aufgaben – eine zum Verfassen neuer Inhalte und eine weitere für Review und Qualitätssicherung. So bleiben Konsistenz gewahrt und Probleme werden erkannt, die in einer einzelnen Sitzung möglicherweise übersehen würden.

​
Teamzusammenarbeit

Teilen Sie die überarbeitete Datei CLAUDE.md mit Ihrem Team, um einheitliche Dokumentationsstandards für alle Beitragenden sicherzustellen. Teams entwickeln häufig projektspezifische Prompts und Workflows, die fester Bestandteil ihres Dokumentationsprozesses werden.

​
Benutzerdefinierte Befehle

Erstellen Sie wiederverwendbare Slash-Befehle in .claude/commands/ für häufige, projektspezifische Dokumentationsaufgaben Ihres Teams.