Un article issu d'un ticket technique résolu documente un symptôme, un environnement vérifié, une solution testée et son contrôle. Supprimez les données du client et limitez les étapes aux conditions démontrées.
Choisir un cas reproductible
Confirmez cause, solution et résultat. Fermer le ticket ne prouve pas le succès. Sans test ou confirmation, ne présentez pas les étapes comme vérifiées.
Choisissez un symptôme. Ne regroupez pas des problèmes différents seulement parce que la même équipe les a traités.
Anonymiser les éléments
Retirez noms, adresses, documents privés, comptes, identifiants de session et secrets techniques. Examinez les captures séparément.
Conservez produit, version, environnement, symptôme et déclencheur utiles. Décrivez prudemment une configuration identifiable sans perdre la cause. Ne publiez pas la correspondance.
Utiliser symptôme–environnement–solution
- Symptôme : ce que voit l'utilisateur et quand.
- Environnement : produit, version, système et configuration.
- Condition : comment reconnaître le cas correspondant.
- Solution : étapes testées pour ce cas.
- Contrôle : résultat attendu.
- Limites et escalade : quand arrêter ou contacter le support.
Le diagnostic n'est pas une réparation. Collecter des données ne résout pas le problème. Pour les protections de données, utilisez la procédure confirmée du produit.
Exemple fictif
Il ne s'agit pas d'une panne de Semly. Dans une application documentaire 2.4.0, une liste ouverte n'affiche pas un nouveau document après un changement confirmé des droits. Recharger actualise la liste, pas les droits.
La session a commencé avant le changement. Le document doit apparaître dans une vue nouvellement ouverte pour le même compte.
Enregistrez le travail non sauvegardé et rechargez selon les instructions réelles. Vérifiez que le document apparaît et s'ouvre avec les bons droits. S'il manque aussi dans la nouvelle vue, ce cas n'est pas confirmé et nécessite un autre diagnostic.
Expliquer les limites
Citez seulement versions et configurations testées. Une interface similaire ne prouve pas la prise en charge d'une autre plateforme.
Ne promettez pas qu'un rechargement répare les droits ou des données absentes. D'autres causes exigent d'autres procédures. La condition évite des étapes inutiles.
Tester comme un lecteur
Un relecteur technique reproduit le cas en sécurité et suit le texte sans connaître le ticket. Conditions et succès sont explicites.
Complétez l'environnement si nécessaire. L'instruction ne doit pas dépendre du savoir exclusif de son auteur.
Garder vérification et traductions
Notez date et responsable. Après évolution du produit, revérifiez conditions et étapes.
Les traductions gardent version, symptôme, ordre et critère de succès. Les messages correspondent à l'interface réelle. Une autre cause forme un autre cas, pas un ajout sans rapport.
