Windsurf

Configurez Windsurf pour qu’il devienne votre assistant d’écriture

Transformez Windsurf en un expert de la documentation qui comprend votre guide de style, vos composants et le contexte de votre projet grâce aux règles de l’espace de travail et aux mémoires.

​

Utiliser Windsurf avec Mintlify

L’assistant Cascade de Windsurf peut être paramétré pour rédiger une documentation conforme à vos standards en utilisant les composants Mintlify. Les règles d’espace de travail et les mémoires fournissent un contexte persistant sur votre projet, garantissant des suggestions plus cohérentes de la part de Cascade.

• Règles d’espace de travail stockées dans votre dépôt de documentation et partagées avec votre équipe.
• Mémoires fournissent un contexte individuel qui s’enrichit au fil du temps.

Nous recommandons de configurer des règles d’espace de travail pour définir des standards de documentation partagés. Vous pouvez développer des mémoires au fil de votre travail, mais comme elles ne sont pas partagées, elles ne seront pas cohérentes entre les membres de l’équipe.

Créez des règles d’espace de travail dans le répertoire .windsurf/rules de votre dépôt de documentation. Consultez Memories & Rules dans la documentation Windsurf pour plus d’informations.

​

Exemple de règle d’espace de travail

Cette règle donne à Cascade du contexte sur les composants Mintlify et les bonnes pratiques générales de rédaction technique.

Vous pouvez utiliser cet exemple de règle tel quel ou le personnaliser pour votre documentation :

• Normes de rédaction : Mettez à jour les consignes linguistiques pour qu’elles correspondent à votre guide de style.
• Modèles de composants : Ajoutez des composants propres à votre projet ou modifiez les exemples existants.
• Exemples de code : Remplacez les exemples génériques par de vrais appels et réponses d’API propres à votre produit.
• Préférences de style et de ton : Ajustez la terminologie, la mise en forme et les autres règles.

Enregistrez votre règle en tant que fichier .md dans le répertoire .windsurf/rules de votre dépôt de documentation.

# Règle de rédaction technique Mintlify

## Contexte du projet

- Projet de documentation sur la plateforme Mintlify
- Nous utilisons des fichiers MDX avec un frontmatter YAML  
- La navigation est configurée dans `docs.json`
- Nous appliquons les bonnes pratiques de rédaction technique

## Normes de rédaction

- Utilisez la deuxième personne (« vous ») pour les instructions
- Rédigez à la voix active et au présent
- Commencez les procédures par les prérequis
- Indiquez les résultats attendus pour les étapes majeures
- Utilisez des titres descriptifs, riches en mots‑clés
- Rédigez des phrases concises mais informatives

## Structure de page requise

Chaque page doit commencer par un frontmatter :

```yaml
---
title: "Titre clair et précis"
description: "Description concise pour le SEO et la navigation"
---
```

## Composants Mintlify

### docs.json

- Consultez le [schéma docs.json](https://mintlify.com/docs.json) lors de la création du fichier docs.json et de la navigation du site

### Encadrés

- `<Note>` pour des informations complémentaires utiles
- `<Warning>` pour des avertissements importants et les changements majeurs
- `<Tip>` pour les meilleures pratiques et des conseils d’experts  
- `<Info>` pour des informations contextuelles neutres
- `<Check>` pour confirmer la réussite

### Exemples de code

- Lorsque c’est pertinent, incluez des exemples complets et exécutables
- Utilisez `<CodeGroup>` pour des exemples dans plusieurs langages
- Indiquez les balises de langage sur tous les blocs de code
- Incluez des données réalistes, pas des valeurs factices
- Utilisez `<RequestExample>` et `<ResponseExample>` pour la documentation d’API

### Procédures

- Utilisez le composant `<Steps>` pour des instructions séquentielles
- Ajoutez des étapes de vérification avec des composants `<Check>` lorsque c’est pertinent
- Décomposez les procédures complexes en étapes plus petites

### Organisation du contenu

- Utilisez `<Tabs>` pour le contenu spécifique à une plateforme
- Utilisez `<Accordion>` pour une divulgation progressive
- Utilisez `<Card>` et `<CardGroup>` pour mettre le contenu en avant
- Enveloppez les images dans des composants `<Frame>` avec un texte alternatif descriptif

## Exigences pour la documentation d’API

- Documentez tous les paramètres avec `<ParamField>` 
- Présentez la structure de la réponse avec `<ResponseField>`
- Incluez des exemples de réussite et d’erreur
- Utilisez `<Expandable>` pour les propriétés d’objets imbriqués
- Incluez toujours des exemples d’authentification

## Normes de qualité

- Testez tous les exemples de code avant publication
- Utilisez des chemins relatifs pour les liens internes
- Incluez un texte alternatif pour toutes les images
- Assurez une hiérarchie de titres correcte (commencez par h2)
- Vérifiez les modèles existants pour la cohérence

​

Utiliser Cascade

Une fois vos règles configurées, vous pouvez utiliser Cascade pour vous aider dans diverses tâches de documentation. Consultez la page Cascade dans la documentation Windsurf pour en savoir plus.

​

Exemples de prompts

Rédaction de nouveau contenu:

renvoyer à la ligne

Créez une nouvelle page expliquant comment s’authentifier avec notre API. Incluez des exemples de code en JavaScript, Python et cURL.

Améliorer le contenu existant:

renvoyer à la ligne

Passez en revue cette page et proposez des améliorations pour la clarté et l’usage des composants. Concentrez-vous sur la rendre les étapes plus faciles à suivre.

Créer des exemples de code:

renvoyer à la ligne

Générez un exemple de code complet illustrant la gestion des erreurs pour cet endpoint d’API. Utilisez des données réalistes et incluez les réponses attendues.

Maintenir la cohérence :

renvoyer à la ligne

Vérifiez si cette nouvelle page respecte nos standards de documentation et proposez les modifications nécessaires.