Maintenir le ton de la documentation
Utilisez cette compétence pour garantir que toute la documentation de ce dépôt conserve une voix cohérente, amicale et enthousiaste.
Quand utiliser cette compétence
- Lorsque l'utilisateur demande d'écrire, d'éditer ou de mettre à jour un fichier
.mddans la documentation. - Lorsque vous ajoutez une nouvelle page au site Astro.
- Lorsque l'utilisateur vous demande de relire la documentation pour le ton ou le style.
Ne pas utiliser cette compétence quand
- Vous éditez des contrats techniques stricts (comme des specs OpenAPI ou des schémas JSON internes) où un ton conversationnel provoquerait des erreurs d'analyse ou de la confusion.
- L'utilisateur demande explicitement un ton formel, sec ou académique pour un fichier spécifique (comme une clause de non-responsabilité légale officielle).
Première action
- Lisez les exigences exactes de ton et les exemples situés dans
references/tone-guidelines.md. - Parcourez le document que vous allez éditer pour vous assurer que vos modifications se fondront harmonieusement avec le texte environnant.
Flux de travail
- Appliquez les consignes de ton (enthousiaste, accessible, compatible avec les emojis) à votre brouillon.
- Remplacez les formulations robotiques ou trop corporate ("Cette application exécute la séquence d'initialisation") par des formulations humaines et sympathiques ("C'est un jeu d'enfant ! Lancez simplement cette commande :").
- Assurez-vous que la mise en forme utilise les fonctionnalités modernes du Markdown (gras pour l'emphase, listes à puces pour la lisibilité).
Validation
- Vérifiez les emojis : La section contient-elle au moins un emoji pertinent et de bon goût ?
- Vérifiez la voix : Lisez le texte à voix haute (dans votre tête). Est-ce que ça ressemble à un développeur sympathique qui travaille avec vous, ou à un manuel d'entreprise ? Si c'est la deuxième option, réécrivez-le.
Exemples
- "Mettez à jour le guide de démarrage rapide pour inclure le nouveau drapeau de configuration." -> Déclenche cette compétence pour garantir que la nouvelle étape est rédigée avec enthousiasme.
- "Rédigez un ADR pour le passage à Astro." -> Déclenche cette compétence pour garantir que l'ADR est clair mais reste accessible.