Verwandle Windsurf in eine Dokumentationsexpertin, die deinen Styleguide, die Komponenten und den Projektkontext anhand von Workspace-Regeln und Memories versteht.

​
Verwendung von Windsurf mit Mintlify

Der Cascade-AI-Assistent von Windsurf lässt sich so konfigurieren, dass er mithilfe von Mintlify-Komponenten Dokumentation nach Ihren Standards erstellt. Arbeitsbereichsregeln und Memories stellen dauerhaften Kontext zu Ihrem Projekt bereit und sorgen so für konsistentere Vorschläge von Cascade.
  • Arbeitsbereichsregeln werden in Ihrem Dokumentations-Repository gespeichert und mit Ihrem Team geteilt.
  • Memories liefern individuellen Kontext, der sich im Laufe der Zeit aufbaut.
Wir empfehlen, Arbeitsbereichsregeln für gemeinsame Dokumentationsstandards einzurichten. Sie können Memories während der Arbeit aufbauen; da sie jedoch nicht geteilt werden, sind sie nicht über Teammitglieder hinweg konsistent. Erstellen Sie Arbeitsbereichsregeln im Verzeichnis .windsurf/rules Ihres Docs-Repos. Weitere Informationen finden Sie unter Memories & Rules in der Windsurf-Dokumentation.

​
Beispiel-Regel für den Arbeitsbereich

Diese Regel liefert Cascade Kontext zu Mintlify-Komponenten und allgemeinen Best Practices für technisches Schreiben. Sie können diese Beispielregel unverändert verwenden oder für Ihre Dokumentation anpassen:
  • Schreibstandards: Passen Sie die Sprachrichtlinien an Ihren Styleguide an.
  • Komponenten-Muster: Fügen Sie projektspezifische Komponenten hinzu oder ändern Sie bestehende Beispiele.
  • Codebeispiele: Ersetzen Sie generische Beispiele durch echte API-Aufrufe und -Antworten für Ihr Produkt.
  • Stil- und Tonpräferenzen: Justieren Sie Terminologie, Formatierung und weitere Regeln.
Speichern Sie Ihre Regel als .md-Datei im Verzeichnis .windsurf/rules Ihres Docs-Repos. 
# Mintlify technical writing rule

## Project context

- This is a documentation project on the Mintlify platform
- We use MDX files with YAML frontmatter  
- Navigation is configured in `docs.json`
- We follow technical writing best practices

## Writing standards

- Use second person ("you") for instructions
- Write in active voice and present tense
- Start procedures with prerequisites
- Include expected outcomes for major steps
- Use descriptive, keyword-rich headings
- Keep sentences concise but informative

## Required page structure

Every page must start with frontmatter:

```yaml
---
title: "Clear, specific title"
description: "Concise description for SEO and navigation"
---
```

## Mintlify components

### docs.json

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

### Callouts

- `<Note>` for helpful supplementary information
- `<Warning>` for important cautions and breaking changes
- `<Tip>` for best practices and expert advice  
- `<Info>` for neutral contextual information
- `<Check>` for success confirmations

### Code examples

- When appropriate, include complete, runnable examples
- Use `<CodeGroup>` for multiple language examples
- Specify language tags on all code blocks
- Include realistic data, not placeholders
- Use `<RequestExample>` and `<ResponseExample>` for API docs

### Procedures

- Use `<Steps>` component for sequential instructions
- Include verification steps with `<Check>` components when relevant
- Break complex procedures into smaller steps

### Content organization

- Use `<Tabs>` for platform-specific content
- Use `<Accordion>` for progressive disclosure
- Use `<Card>` and `<CardGroup>` for highlighting content
- Wrap images in `<Frame>` components with descriptive alt text

## API documentation requirements

- Document all parameters with `<ParamField>` 
- Show response structure with `<ResponseField>`
- Include both success and error examples
- Use `<Expandable>` for nested object properties
- Always include authentication examples

## Quality standards

- Test all code examples before publishing
- Use relative paths for internal links
- Include alt text for all images
- Ensure proper heading hierarchy (start with h2)
- Check existing patterns for consistency

​
Arbeiten mit Cascade

Sobald Ihre Regeln eingerichtet sind, können Sie Cascade für verschiedene Aufgaben in der Dokumentation nutzen. Weitere Informationen finden Sie in der Windsurf-Dokumentation unter Cascade.

​
Beispielanweisungen

Neue Inhalte verfassen: 
Erstelle eine neue Seite, die erklärt, wie man sich bei unserer API authentifiziert. Füge Codebeispiele in JavaScript, Python und cURL hinzu.
Bestehende Inhalte verbessern: 
Überprüfe diese Seite und schlage Verbesserungen hinsichtlich Verständlichkeit und Nutzung der Komponenten vor. Konzentriere dich darauf, die Schritte leichter nachvollziehbar zu machen.
Codebeispiele erstellen: 
Erzeuge ein vollständiges Codebeispiel, das das Fehlerhandling für diesen API-Endpunkt zeigt. Verwende realistische Daten und füge erwartete Antworten hinzu.
Konsistenz wahren: 
Prüfe, ob diese neue Seite unseren Dokumentationsstandards entspricht, und schlage gegebenenfalls notwendige Änderungen vor.