Windsurf

Configurez Windsurf pour en faire 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 IA Cascade de Windsurf peut être paramétré pour rédiger une documentation conforme à vos standards en utilisant des 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.

• Les règles d’espace de travail sont stockées dans votre référentiel de documentation et partagées avec votre équipe.
• Les mémoires fournissent un contexte individuel qui s’enrichit au fil du temps.

Nous recommandons de définir des règles d’espace de travail pour 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 d’un membre de l’équipe à l’autre.

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

​

Exemple de règle pour l’espace de travail

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

Vous pouvez utiliser cette règle d’exemple telle quelle ou la personnaliser pour votre documentation :

• Normes de rédaction : Mettez à jour les directives linguistiques pour les aligner sur votre guide de style.
• Modèles de composants : Ajoutez des composants spécifiques à votre projet ou modifiez les exemples existants.
• Exemples de code : Remplacez les exemples génériques par de véritables appels et réponses d’API pour 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 comme 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

- Il s'agit d'un projet de documentation sur la plateforme Mintlify
- Nous utilisons des fichiers MDX avec du frontmatter YAML  
- La navigation est configurée dans `docs.json`
- Nous suivons les meilleures pratiques de rédaction technique

## Standards 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
- Incluez les résultats attendus pour les étapes importantes
- Utilisez des titres descriptifs et riches en mots-clés
- Gardez les phrases concises mais informatives

## Structure de page requise

Chaque page doit commencer par du frontmatter :

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

## Composants Mintlify

### docs.json

- Référez-vous au [schéma docs.json](https://mintlify.com/docs.json) lors de la construction du fichier docs.json et de la navigation du site

### Encadrés

- `<Note>` pour des informations supplémentaires utiles
- `<Warning>` pour des avertissements importants et des changements majeurs
- `<Tip>` pour les meilleures pratiques et conseils d'expert  
- `<Info>` pour des informations contextuelles neutres
- `<Check>` pour les confirmations de succès

### Exemples de code

- Le cas échéant, incluez des exemples complets et exécutables
- Utilisez `<CodeGroup>` pour des exemples en plusieurs langages
- Spécifiez les balises de langage sur tous les blocs de code
- Incluez des données réalistes, pas des espaces réservés
- Utilisez `<RequestExample>` et `<ResponseExample>` pour la documentation API

### Procédures

- Utilisez le composant `<Steps>` pour les instructions séquentielles
- Incluez des étapes de vérification avec les composants `<Check>` quand c'est pertinent
- Divisez les procédures complexes en étapes plus petites

### Organisation du contenu

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

## Exigences de documentation API

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

## Standards de qualité

- Testez tous les exemples de code avant publication
- Utilisez des chemins relatifs pour les liens internes
- Incluez du texte alternatif pour toutes les images
- Assurez-vous d'une hiérarchie de titres appropriée (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 section Cascade dans la documentation de Windsurf pour en savoir plus.

​

Exemples d’invites

Rédaction de contenu :

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 :

Examinez cette page et proposez des améliorations pour la clarté et l'utilisation des composants. Concentrez-vous sur la facilitation du suivi des étapes.

Créer des exemples de code :

Générez un exemple de code complet montrant la gestion des erreurs pour ce point de terminaison API. Utilisez des données réalistes et incluez les réponses attendues.

Assurer la cohérence :

Vérifiez si cette nouvelle page respecte nos normes de documentation et suggérez les modifications nécessaires.